Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 2.77 KB

Contributing.md

File metadata and controls

41 lines (29 loc) · 2.77 KB

Contribution guidelines

The pull request should have a useful title. Pull requests with “Update readme.md” as title will be closed right away. Please carefully read everything in Adding something to this list.

Table of contents

Adding something to an awesome list

If you have something awesome to contribute to the list, this is how you do it.

You’ll need a GitHub account!

  1. Access the awesome list’s GitHub page.
  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 below. 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!

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.
  • Use sentence casing.
  • Use the following format: [Link title](link) — description.
  • Drop “a”, “an” or “the” at the beginning.
  • All links are sorted alphabetically.
  • 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.
  • The body of your commit message should contain a link you’re adding.

Updating your pull request

Sometimes, a maintainer of an awesome list will ask you to edit your pull request before it’s merged. This is normally due to spelling errors or because your pull request didn’t match the list guidelines.

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