mirror of
https://github.com/sindresorhus/awesome.git
synced 2024-12-29 20:35:26 +00:00
2.2 KiB
2.2 KiB
Contribution Guidelines
Adding to this list
Please ensure your pull request adheres to the following guidelines:
- Search previous suggestions before making a new one, as yours may be a duplicate.
- Make sure the list is useful before submitting. That implies it has enough content and every item has a good succinct description.
- Make an individual pull request for each suggestion.
- Titles should be capitalized.
- Use the following format:
[List Name](link)
- Link additions should be added to the bottom of the relevant category.
- New categories or improvements to the existing categorization are welcome.
- Check your spelling and grammar.
- Make sure your text editor is set to remove trailing whitespace.
- The pull request and commit should have a useful title.
Thank you for your suggestions!
Creating your own awesome list
To create your own list, check out the instructions.
Adding something to an Awesome list
If you have something awesome to contribute to an awesome list, this is how you do it.
You'll need a GitHub account!
- Access the awesome list's GitHub page. For example: https://github.com/sindresorhus/awesome
- Click on the
readme.md
file: - Now click on the edit icon.
- You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use GitHub Flavored Markdown.
- Say why you're proposing the changes, and then click on "Propose file change".
- Submit the pull request!