Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

35 lines (26 loc) · 1.9 KB

Contribution Guidelines

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Ensure your pull request adheres to the following guidelines:

  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • If you just created something, wait at least a couple of weeks before submitting.
  • Submitted open source apps should have a English readme, screenshot of the app in the readme, and a binary for at least one OS, preferably macOS, Linux and Windows.
  • Submitted packages should be tested and documented.
  • Make an individual pull request for each suggestion.
  • Use the following format: [resource](link) - Description.
  • Additions should be added to the bottom of the relevant section.
  • New categories, or improvements to the existing categorization are welcome.
  • Keep descriptions short and simple, but descriptive.
  • Start the description with a capital and end with a full stop/period.
  • Check your spelling and grammar.
  • Make sure your text editor is set to remove trailing whitespace.
  • The pull request should have a useful title and include a link to the package and why it should be included.

Thank you for your suggestion!

Updating your PR

A lot of times, making a PR adhere to the standards above can be difficult. If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it. If you're not sure how to do that, here is a guide on the different ways you can update your PR so that we can merge it.


Working on your first Pull Request?
You can learn how from this free series
How to Contribute to an Open Source Project on GitHub
Happy Coding :)