Archives/papers-we-love_papers-we-love
1
0
Fork 0
mirror of https://github.com/papers-we-love/papers-we-love.git synced 2024-10-27 20:34:20 +00:00
Code Issues Projects Releases Wiki Activity
709faf7978
papers-we-love_papers-we-love/.github/CONTRIBUTING.md
Mike JS. Choi 0fb9de52ae Fix broken link to ACM copyright link in CONTRIBUTING.md (#431) 
* fix broken link to acm copyright link

* Add missing `/` to link

Fix broken link to ACM's license 1
2017-02-13 11:18:39 -05:00

3.1 KiB
Raw Blame History

Contributing Guidelines

We have a few guidelines in place to keep the repo clean and easy to navigate. We recommend that you follow these conventions in your pull-request for a speedy merge. Note that every pull request we receive must have Two-Thumbs-Up minimum from PWL organizers/collaborators to be merged.

Follow the group's ethos

We want to help bring academic research closer to practitioners and we strive to:

  • Adhere to Papers We Love Code of Conduct.
  • Keep the quality of papers listed high: Books, blogposts, and/or reference pdfs don't go through the same review process that academic papers do and we won't add them to this repo.
  • Help people understand why a paper is important: We ask that you include with your commit an update to the directory README with a short justification of why you love this paper (for example: A paper might be interesting because it spawned a new domain, it was exceptionally well-written, or perhaps it was completely wrong about something.) Take look at this pull request as a model.

Respect content licenses

  • We will only merge pull requests that contain research papers that allow digital distribution. Papers whose copyright prohibits redistribution will not be accepted; for example license 1 from the ACM digital library.
  • We encourage papers that do not allow digital distribution to be added to a README, with a link to the source URL, in the appropriate subject's folder. For example, the distributed systems README.

Follow our commit, naming, and directory-organization conventions

  • Directory names are undercased and separated by underscores (example: artificial_intelligence)
  • Paper names are undercased and separated by dashes (example: out-of-the-tar-pit.pdf). Use the full title when possible.
  • If your pull request includes a binary file, like a *.pdf for example, please still include a link to the source URL in the appropriate subject's folder's README file and highlight it with a 📜 emojii to show that the directory contains the file itself. Here's an example pull request.
  • After raising this issue, it would beneficial to also include the year along with the title, link, and description/importance when adding paper(s) to a README.
  • Please rebase all multi-commit branches/PRs into 1 single commit.

Copyright

The name "Papers We Love" and the logos for the organization are copyrighted, and under the ownership of Papers We Love Ltd, all rights reserved. When starting a chapter, please review our guidelines and ask us about using the logo.