awesome/contributing.md
2015-07-25 21:32:45 +02:00

1.2 KiB

Contribution Guidelines

Please ensure your pull request adheres to the following guidelines:

  • Read the awesome manifesto and ensure your list complies.
  • Wait at least a couple of weeks after creating a list before submitting to give it a chance to mature.
  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Make sure your list is useful before submitting. That implies it having enough content and every item a good succinct description.
  • A link back to this list from yours, so users can discover more lists, would be appreciated.
  • 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!