Skip to content

Latest commit

 

History

History
43 lines (32 loc) · 2.62 KB

contributing.md

File metadata and controls

43 lines (32 loc) · 2.62 KB
Raw

Contribution Guidelines

Guidelines

Ensure your pull request adheres to the following guidelines:

  • Keep in mind this is an awesome list, not any piece of crap you find
  • All links must be relevant, tested and well described
  • Mark commercial products, including the street price, if possible
    • 💰 = tens of dollars
    • 💰💰 = hundreds of dollars
    • 💰💰💰 = thousands of dollars
  • For any commercial product inserted, make sure you add free/open source alternatives
  • Open source links should include the license in brackets i.e. (MIT)

Thank you for your suggestions!

Adding content to this awesome list (Pull Request)

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. 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!

If we ask you to update your Pull Request

A lot of times, making a Pull Request adhere to the standards above can be difficult. If the maintainers notice anything that we'd like changed, we'll ask you to edit your Pull Request before we merge it. There's no need to open a new Pull Request, just edit the existing one. If you're not sure how to do that, here is a guide on the different ways you can update your Pull Request so that we can merge it.