BiblioDrift logo BiblioDrift
Back to landing
Contribution guide for UI, docs, logic, and accessibility work

Contributing to BiblioDrift

Thanks for taking the time to contribute. BiblioDrift is a calm, visual-first book discovery platform, and contributions should improve the experience without breaking the mood-driven flow.

Keep changes focused Test before opening a PR

What You Can Contribute

Short, focused contributions are easiest to review. Common helpful tasks:

Bug fixes

Reproduce, fix, and add a brief test or steps to reproduce.

UI & accessibility

Small spacing, focus, contrast, or responsive fixes that improve clarity.

Docs & setup

Tighten setup steps, add troubleshooting notes, or short how-tos.

Tests

Add/adjust tests for regressions or core behaviors.

Quick checklist before opening a PR: fork & branch, run tests, keep changes small, and include a short description or screenshot.

Setup

Quick 3-step local setup to get started:

  1. Clone: fork the repo and clone your fork locally.
  2. Env & deps: create a virtual environment and install the project's requirements.
  3. Run: run the test suite or start the backend (see backend/app.py) to verify your changes.

See README for full environment notes and troubleshooting.

Project Pages

These are the main pages contributors usually move between while reviewing or updating the experience.

Landing page The main public entry point for the project. Contributors Browse the full contributor list in one place. Discovery app The reading experience and main app entry. README High-level overview, setup notes, and project context.

Pull Request Process

Keep PRs small and focused. Quick guidance:

  • Branch from `main` with a clear name (e.g., feat/... or fix/...).
  • Describe what changed, how to test, and link related issues.
  • Run tests; include screenshots for UI changes.

Concise PRs get reviewed faster.

Style Guide

  • Prefer plain HTML/CSS/Vanilla JS for frontend work; avoid adding frameworks without discussion.
  • Use semantic markup and accessible patterns; prefer existing CSS variables in frontend/css/style.css.
  • For backend, follow current Python conventions and add tests for behavior changes.

See docs/contributing.md for details; open an issue to discuss large changes.