diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4e5b3c2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Contribution Guidelines + +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 bottom of the relevant category. +- 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 suggestions!