👍🎉 First off, thanks for taking the time to contribute to NewsLynx! 🎉👍
The following is a set of guidelines for contributing to newslynx-sc-rss
,
which is hosted by newslynx on GitHub.
These are just guidelines, not rules, use your best judgment and feel free to
propose changes to this document in a pull request.
- All issues should be filed on NewsLynx's centralized opportunity tracker.
- When submitting an issue for
newslynx-sc-rss
, make sure to add the labelsous-chef
.
- When making a significant addition to
newslynx-sc-rss
, make sure to prefix your branch name withfeature/
and increment the second number of the VERSION (IE:0.2.1
=>0.3.0
). - When fixing a typo or a minor bug, make sure to prefix your branch name with
hotfix/
and increment the third number of the VERSION (IE:0.2.1
=>0.2.2
) - When applicable, add / modify existing tests in your pull request.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally