If you discover issues, have ideas for improvements or new features, please report them to the issue tracker of the repository or submit a pull request for the specific project.
Please, try to follow these guidelines when you do so.
- Check that the issue has not already been reported, if it has and you can provide additional information please feel free to do so.
- Check that the issue has not already been fixed in the latest code.
- Be clear, concise and precise in your description of the problem.
- Open an issue with a descriptive title and complete all of the questions in grammatically correct, complete sentences. Add an additional information you think is relevant.
- Specify which version you are running as this will help us when we attempt to replicate the issue.
- Include any relevant code to the issue summary.
If you have an idea for a new feature or improvement that you would like to see, but you can't (or don't want to) make the change yourself to the code, then you can also log this by using the issue tracker.
- Read how to properly contribute to open source projects on GitHub.
- Fork the project.
- Use a topic/feature branch to easily amend a pull request later, if necessary.
- Write good commit messages.
- Use the same coding and documentation conventions as the rest of the project. If not your pull request might well be rejected.
- Commit and push until you are happy with your contribution.
- If your change has a corresponding open GitHub issue, prefix the commit message with
- Make sure to add tests for it. This is important so we don't break it in a future version unintentionally.
- Add an entry to the CHANGELOG.md accordingly. See changelog entry format.
- Make sure that the code passes any existing tests cleanly.
- Squash related commits together.
- Open a pull request that relates to only one subject with a clear title and description in grammatically correct, complete sentences.
NOTE: We reserve the right to reject any pull requests that do not meet this requirements. We will however feedback on why pull requests were rejected.
Changelog entry format
- If your change has a corresponding open GitHub issue then prefix your changelog entry with
Here are a few examples:
Linking to an existing issue
* [#2](https://github.com/wolfsoftware/contributing/issues/2): Fixed broken links within the main README.md ([@TGWolf])
Adding a new feature
* Added a new command line option (-q) to allow for standard output to be surpress. ([@TGWolf])
- Make sure you add the changelog entry into the correct section. (BUG FIXES, IMPROVEMENTS, NEW FEATURES, BACKWARDS INCOMPATIBILITIES, NOTES)
- Mark it up in Markdown syntax.
- The entry line should start with
*(an asterisk and a space).
- Describe the brief of the change. The sentence should end with a punctuation.
- At the end of the entry, add an implicit link to your GitHub user page as
- If this is your first contribution to the project, add a link definition for the implicit link to the bottom of the changelog as