-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
1_Start Here
Mek edited this page Jun 27, 2024
·
6 revisions
If you don't have Docker, VSCode, and a dev environment checkout the Environment Setup.
- Find a good first issue you're interested in!
docker compose up
- Change a a file
-
.html
,.py
- changes should be reflected when you refresh -
.less
- you'll have to run:docker compose run --rm home make css
-
.js
- you'll have to run:docker compose run --rm home make js
- Write/run tests if needed
docker compose run --rm home make test
- Open a PR
- Please include a video of your change (or at least screenshots)
- Your PR will be reviewed/merged in about one week! 🎉
- Read the in depth contributing guide
- Import production data
- Read some FAQs
- Checkout the architecture of the app
- Write a bot for us
- Improve the docs
- Help us develop a whole new feature
Getting Started & Contributing
- Setting up your developer environment
- Using
git
in Open Library - Finding good
First Issues
- Code Recipes
- Testing Your Code, Debugging & Performance Profiling
- Loading Production Site Data ↦ Dev Instance
- Submitting good Pull Requests
- Asking Questions on Gitter Chat
- Joining the Community Slack
- Attending Weekly Community Calls @ 9a PT
- Applying to Google Summer of Code & Fellowship Opportunities
Developer Resources
- FAQs: Frequently Asked Questions
- Front-end Guide: JS, CSS, HTML
- Internationalization
- Infogami & Data Model
- Solr Search Engine Manual
- Imports
- BookWorm / Affiliate Server
- Writing Bots
Developer Guides
- Developing the My Books & Reading Log
- Developing the Books page
- Understanding the "Read" Button
- Using cache
- Creating and Logging into New Users
- Feature Flagging
Other Portals
- Design
- Librarianship
- Communications
- Staff (internal)
Legacy
Old Getting Started
Orphaned Editions Planning
Canonical Books Page