Skip to content

Latest commit

 

History

History
63 lines (38 loc) · 3.45 KB

contributing.md

File metadata and controls

63 lines (38 loc) · 3.45 KB
Raw

Contribution Guidelines

Thank you for considering contributing to this list!

Table of Contents

Basic information

Please send a GitHub Pull Request to this repository with a clear list of what you've done (read more about pull requests).

Working on your first Pull Request? See this tutorial: How To Create a Pull Request on GitHub

For further questions you can contact me by way of GitHub issues, Twitter or E-Mail.

Adding to this list

Please ensure your pull request adheres to the following guidelines:

  • Please reference primarily resources and tools which can be used either off-the-shelf or with minor adjustments and which are still maintained.
  • 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.
  • Use title-casing (AP style).
  • Use the following format: [List Name](link)
  • Link additions should keep the alphabetical ordering.
  • 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!

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!

  1. Access the awesome list's GitHub page. For example: https://github.com/sindresorhus/awesome
  2. Click on the readme.md file: Step 2 Click on Readme.md
  3. Now click on the edit icon. Step 3 - Click on Edit
  4. 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
  5. Say why you're proposing the changes, and then click on "Propose file change". Step 5 - Propose Changes
  6. 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.

Thanks,

Adrien