Please use this new Wiki. Welcome to the Open Library Handbook! Here you will learn how to...

• Get Set Up
  • Install Open Library
  • Find a Good First Issue
  • Use Git to work on an issue
  • Test, Feature Flag, Debug & Profile your code
  • Submit a good Pull Request
• Understand the Codebase
  • Identify which file(s) power each URL Endpoint
  • Trace step-by-step the Lifecycle of a Network Request through the application
  • Add a new Endpoint
• Contribute to the Front-end
  • Work with HTML Templates
    • Asynchronously load Template Partials
    • Internationalize (i18n) Templates
  • Work with and build JS & CSS
  • Refer to our Design Pattern Library and Figma Design System
• Contribute to the Back-end
  • Understand our Database Model (DDL)
  • Work with Solr search engine
  • Work on the Import Pipeline and Write Librarian Bots
  • Use or Write APIs
  • Diagram the Production Architecture
  • Understand Infogami and the Tech Stack
• Manage your developer environment
  • Import production data into your local environment
  • Create new users
• Lookup Common Recipes
  • Use cache, cookies, fetching from db
• Participate in the Community
  • Request for a slack invite
  • Attend Weekly Community Calls, Tues @ 9a PT
  • Volunteer for a Fellowship
  • Apply for GSoC

Developer Guides

• BookWorm / Affiliate Server
• Developing the My Books & Reading Log
• Developing the Books page
• Understanding the "Read" Button

Project Management

1. Directory of Projects
2. Important Documents by Year
3. Responsibilities Matrix

Other Portals

• Design
• Librarianship
• Communications
• Staff (internal)