Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 2.42 KB

contributing.md

File metadata and controls

34 lines (22 loc) · 2.42 KB

Contribution Guidelines

Thank you for your interest in contributing!

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 an individual pull request for each suggestion.
  • If a category or section doesn't exist yet, propose the category/section by adding it at the appropiate place and be sure to add it to the table of contents.
  • If existing resources are not placed in the right category, move it in a different pull request or open an issue.
  • If you add resources with descriptions, add a dash (-) after the link and end the description with a dot (.) .

Thank you for your suggestions!

You can find instructions below on creating a pull request in order to contribute something to this awesome list.

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.