awesome-readme/contributing.md

17 lines
740 B
Markdown
Raw Normal View History

2015-01-19 06:20:32 +00:00
# Contribution Guidelines
Please ensure your pull request adheres to the following guidelines:
2017-11-19 22:11:50 +00:00
- Alphabetize your entry.
2024-07-04 19:00:58 +00:00
- Search for previous suggestions before making a new one, as yours may be a duplicate.
2015-01-19 06:20:32 +00:00
- Suggested READMEs should be beautiful or stand out in some way.
- Make an individual pull request for each suggestion.
2024-07-04 19:00:58 +00:00
- New categories or improvements to the existing categorization are welcome.
2015-01-19 06:20:32 +00:00
- 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.
2024-07-04 19:00:58 +00:00
- Use the `#readme` anchor for GitHub READMEs to link them directly.
2015-01-19 06:20:32 +00:00
2017-11-19 22:11:50 +00:00
Thank you for your suggestions!