-
The goal is to identify high-quality open source projects that are suitable to read. We try NOT to be an exhaustive list of popular open source projects. So when you submit a pull request, please give some notion of why it's a good project to read, and how people can go about reading it. Your insight will help spark discussions.
-
You should personally read and understand the project you submit. Ideally you can write up a guide or summary so that people can follow.
-
Please specify which release/version of the project. Open source projects are moving fast. A new release can be very different from what it looked like several months ago. By specifying a release/version, it helps people to reproduce your reading experience. Here are 2 tips related to this point:
- You don't have to read the latest release of the project. An earlier version may be much simpler and easier to read. For example, while the Bitcoin codebase is fairly large today, bitcoin 0.1.5 released in 2009 is much manageable and still highly relevant today.
- You don't have to nominate an entire project. A subset or a package within a large project is perfectly fine. As a matter fact, it is less daunting and usually works even better. For example, the sort package within the Go standard library is self-contained, easy to read, and idiomatic.
-
When you submit a pull request, a custom pull request template will be used automatically. Please answer the questions in the pull request template as best you can. See this pull request for an example. After your pull request is merged, we will take care of creating a new issue for discussion.
Thank you again for contributing!