Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 1.98 KB

contributing.md

File metadata and controls

31 lines (22 loc) · 1.98 KB
Raw

Contribution Guidelines

Please note that this project is released with a Contributor Code of Conduct and under a CC0 1.0 Universal License. By participating in this project you agree to abide by those terms.

Table of Contents

Adding to This List by Pull Request

Please ensure your pull request adheres to the following guidelines:

  • Search previous list entries before making a new one, as yours may be a duplicate.
  • Make sure the entry is useful before submitting. (That implies it is easily accessible, currently useful as software or a reference, and has undergone some type of professional review.)
  • Categories should have 10s - 100s of entries, not thousands. We track some papers in our library, but are not necessarily seeking paper or preprint contributions at this time. (That's what arXiv is for, right?)
  • Make an individual pull request for each added entry.
  • Add the new entry in alphabetical order in the appropriate category.
  • Use title-casing (AP style).
  • Use the following format: * [Resource Name](link)
  • 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 to the software or reference you are adding.

Updating your Pull Request

Sometimes, a maintainer of this list may 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 or Code of Conduct.

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