Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 2.96 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 2.96 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. We are unlikely to accept pull requests with Update readme.md as the title. 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:

  • Look at previous suggestions before making a new one, as yours may be a duplicate.
  • Make sure the entry is useful before submitting. That implies it has the author's name and a succinct description/"takeaway" after the link.
    • The entry format should follow this model: [The Title of Your Article](link) - by author. Takeaway: ...
    • Use a - to separate the link and description.
  • Takeaways should avoid sub-bullets and be complete sentences.
  • Use quotation marks when you're quoting verbatim.
  • Make one individual pull request per each new entry/suggestion.
  • Use title-casing (AP style), regardless of the style used by the original article.
  • Add link additions in alphabetical order.
    • Disregard articles (the/an/a) coming at the beginning of titles and use the next word.
  • 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.

Thank you for your suggestions!

Adding something to an awesome list: how-to

If you have something awesome to contribute to this list, here's how you do it.

You'll need a GitHub account!

  1. Visit this 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. Start editing the file text in the in-browser editor. Make sure you follow guidelines above. 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: How-to Info

We might ask you to edit your pull request before including it, due to spelling errors or because your PR didn't follow the guidelines. Here is a write-up on how to change a pull request.