Skip to content

Latest commit

 

History

History
59 lines (42 loc) · 3.79 KB

Contributing.md

File metadata and controls

59 lines (42 loc) · 3.79 KB
Raw

Contribution Guidelines

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

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 to this list.

Table of Contents

Adding to this list

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 sure the repository or organization is useful before submitting.
    • An organization should have more than 1 active repository. This list isn't to replicate Github's list of Government Organizations
      • Use the following format: [City Name, State](link to Github organization)
      • List should be ordered alphabetically by City Name (for now)
    • A repository should be actively maintained and have detailed instructions on how to fork it
      • Use the following format: [Name](link) - Why it's awesome
      • Include a one-sentence description of why this repository is awesome
      • Additions should be added to the bottom of the relevant category.
  • Make an individual pull request for each suggestion.
  • Use Title Casing (AP style).
  • New categories or improvements to the existing categorization are welcome.
  • Read Adding something to an awesome list
  • 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 to the repository.

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.

Creating your own awesome list

To create your own list, check out the instructions.