Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 2.04 KB

contributing.md

File metadata and controls

46 lines (30 loc) · 2.04 KB

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.

Please ensure your pull request adheres to the following guidelines:

  • Search previous suggestions before making a new one to ensure yours is not a duplicate.
  • Make an individual pull request for each suggestion.
  • New categories, or improvements to the existing ones are welcome.
  • Make sure your text editor is set to remove trailing whitespace.
  • Try to ensure your pull requests only have one commit if possible. You can squash your commits into one before submitting.
  • Make your pull request titles and descriptions as detailed as possible. Explain why an asset or resources deserves to be added to the list.
  • Make sure your additions are in alphabetical order. This includes the headers and items themselves.

Software & Website use the following format:

[Name](Link) - Description

Markdown code example:

[Colorize Photos](https://demos.algorithmia.com/colorize-photos/) - Use deep learning to automatically colorize black and white photos

Paper use the following format:

Paper Name (year), Author. [[pdf]](Link)

Markdown code example:

Distilling the knowledge in a neural network (2015), G. Hinton et al. [[pdf]](http://arxiv.org/pdf/1503.02531)

The pdf link which can directly download the pdf file rather than links to another webpage is preferred. If the number of authors are more than two, please write the first author's name only.

Thank you for your suggestions!

Updating your PR

A lot of times, making a PR 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 PR before we merge it. There's no need to open a new PR, 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 PR so that we can merge it.