Skip to content

Commit a1ee7d2

Browse files
author
Stephen Powis
committed
improve readme
1 parent bd7cce8 commit a1ee7d2

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,45 @@ final KafkaConnectClient client = new KafkaConnectClient(configuration);
9090

9191
```
9292

93+
# Contributing
94+
95+
Found a bug? Think you've got an awesome feature you want to add? We welcome contributions!
96+
97+
98+
## Submitting a Contribution
99+
100+
1. Search for an existing issue. If none exists, create a new issue so that other contributors can keep track of what you are trying to add/fix and offer suggestions (or let you know if there is already an effort in progress). Be sure to clearly state the problem you are trying to solve and an explanation of why you want to use the strategy you're proposing to solve it.
101+
1. Fork this repository on GitHub and create a branch for your feature.
102+
1. Clone your fork and branch to your local machine.
103+
1. Commit changes to your branch.
104+
1. Push your work up to GitHub.
105+
1. Submit a pull request so that we can review your changes.
106+
107+
*Make sure that you rebase your branch off of master before opening a new pull request. We might also ask you to rebase it if master changes after you open your pull request.*
108+
109+
## Acceptance Criteria
110+
111+
We love contributions, but it's important that your pull request adhere to some of the standards we maintain in this repository.
112+
113+
- All tests must be passing!
114+
- All code changes require tests!
115+
- All code changes must be consistent with our checkstyle rules.
116+
- Great inline comments.
117+
118+
# Other Notes
119+
120+
121+
## Releasing
122+
123+
Steps for proper release:
124+
- Update release version: `mvn versions:set -DnewVersion=X.Y.Z`
125+
- Validate and then commit version: `mvn versions:commit`
126+
- Update CHANGELOG and README files.
127+
- Merge to master.
128+
- Deploy to Maven Central: `mvn clean deploy -P release`
129+
- Create release on Github project.
130+
131+
93132
## Changelog
94133

95134
The format is based on [Keep a Changelog](http://keepachangelog.com/)

0 commit comments

Comments
 (0)