Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

38 lines (26 loc) · 2.59 KB
Raw

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 entries should refer to tested and documented code
  • Projects should be relevant to the topic and (preferably) under active development.
  • 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.
  • End all descriptions with a full stop/period.
  • Check your spelling and grammar.
  • Make sure your text editor is set to remove trailing whitespace.

Markdown format to use for new entries (see existing examples):

  • If there is only a repository, use the following format: [NAME](REPO-LINK) - DESCRIPTION.
  • If there is a website and a repositry, use the following format: [NAME](WEBSITE-LINK) | [GITHUB-ICON](REPO-LINK) - DESCRIPTION

Thank you for your suggestions!

Adding entries to the list

If you have something awesome to contribute to this list, this is how you do it. (note: instructions copied from the-root-of-all-awesome lists 😄)

You'll need a GitHub account!

  1. Click on the readme.md file: Step 2 Click on Readme.md
  2. Now click on the edit icon. Step 3 - Click on Edit
  3. 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. Step 4 - Edit the file
  4. Say why you're proposing the changes, and then click on "Propose file change". Step 5 - Propose Changes
  5. Submit the pull request!

Updating your Pull Request

Sometimes, a maintainer of an awesome list will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the awesome-* list guidelines.

Here is a write up on how to change a Pull Request, and the different ways you can do that.