mirror of
https://github.com/tiennm99/awesome-readme-tools.git
synced 2026-10-13 00:14:18 +00:00
docs: add contributing guidelines
This commit is contained in:
1 parent
b224dd61bf
commit
010836dd3c
1 file changed
+18
@@ -0,0 +1,18 @@
|
||||
# Contribution Guidelines
|
||||
|
||||
Please note that this project is released with a [Contributor Code of Conduct](code-of-conduct.md). By participating in this project you agree to abide by its terms.
|
||||
|
||||
Please ensure your pull request adheres to the following guidelines:
|
||||
|
||||
- Alphabetize your entry.
|
||||
- Search previous suggestions before making a new one, as yours may be a duplicate.
|
||||
- Suggested README tools should be beautiful or stand out in some way.
|
||||
- Make an individual pull request for each suggestion.
|
||||
- New categories or improvements to the existing categorization are welcome.
|
||||
- Keep descriptions short and simple but descriptive.
|
||||
- If you are the tool owner and want to update the description of your tool entry which I have added, then you are welcome ✌.
|
||||
- Start the description with a capital and end with a full stop/period.
|
||||
- Check your spelling and grammar.
|
||||
- Make sure to use `.editorconfig` for formating.
|
||||
|
||||
Thank you for your suggestions!
|
||||
Reference in new issue
Block a user