Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 1.58 KB

contributing.md

File metadata and controls

34 lines (26 loc) · 1.58 KB
Raw

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.

Please ensure your pull request adheres to the following guidelines:

  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Suggested packages should be tested and documented.
  • Make an individual pull request for each suggestion.
  • Use the following format: [package](link) - Description.
  • Additions should be added to the relevant category, sorted alphabetically.
  • New categories, or improvements to the existing categorization are welcome.
  • Keep descriptions short and simple, but descriptive.
  • Don't mention Capacitor in the description or package title as it's implied.
  • 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 suggestions!

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. There's no need to open a new PR, just edit the existing one. 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.