Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 2.3 KB

contributing.md

File metadata and controls

43 lines (31 loc) · 2.3 KB
Raw

Contribution Guidelines

You need a GitHub account to contribute, but you don't need to install git on your computer.

Contributing can be done via the web browser.

Pull requests should have descriptive titles. Update README.md is not an acceptable title. Please read the follow sections before submitting a pull request.

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.
  3. Now click on the edit icon.
  4. Start editing the file text in the in-browser editor. Make sure you follow guidelines above.
  5. Say why you're proposing the changes, and then click on "Propose file change."
  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.