Installing Open Library For instructions on setting up a local developer's instance of Open Library, please refer to https://github.com/internetarchive/openlibrary#installation. Also, refer to the Quickstart Guide: https://github.com/internetarchive/openlibrary/blob/master/Quickstart.md (might be outdated)
Resources for Contributors
Look through our issues related to contributing
:
https://github.com/internetarchive/openlibrary/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3Acontributing
Want to Participate in the Community?
- Ask here to join our Open Library slack: internetarchive#686
- Join us for our Open Library Community Call every Tuesday @ 11:30am PT
Data Cleanup
- If you notice a set of entries on Open Library which need to be updated (possibly in bulk) please report them as an issue to https://github.com/internetarchive/openlibrary-client (the Open Library Client).
Tagging
- If a task requires immediate fixing, please respond to its corresponding issue by asking if it can be promoted to
blocking
using the blocking issue label.
We usually discuss weekly goals via our Tuesday Community Call and using slack.
Our Roadmap(s)
- Our weekly tasks are tracked here: https://github.com/internetarchive/openlibrary/projects/4
- Our quarterly goals can be found on the projects board: https://github.com/internetarchive/openlibrary/projects -- e.g. https://github.com/internetarchive/openlibrary/projects/3 (2018 Q1)
Picking 1st task
- Look for issues with labels such as
good first issue
andeasy
Whenever working on a new feature/hotfix/refactor, the first step is to make sure a corresponding issue exists. We then take this issue number and affix it to the branch name which we will use for development.
A branch name consists of the: issue number, whether it is a feature/hotfix/refactor, and a human readable slug, e.g:
123/refactor/simplifying-authentication-using-xauthn
When your code is ready for review, please follow our Pull Request Template to close the corresponding issue.
- Pull Requests (PRs) must link to the issue they resolve. Please expect PRs without corresponding issues to be rejected until an issue is retroactively created and linked to it.