Files
bookhoard/docs/contributing/contributing.md
T
John O'Keefe f42720ac64 docs: retire PROJECT_GUIDELINES.md — library-visibility rule now in AGENTS.md + dev docs
PROJECT_GUIDELINES.md had drifted out of reality (podman-only rule
while the stack runs docker; verifier scripts wired to Makefile targets
nobody runs). Trashed it, its two verifier scripts, and the Makefile
targets; the rules that still matched reality (docker runtime, schema
in place until release, server binary only via Docker, services layer,
integration-test pool rules) are absorbed into the new AGENTS.md.

The library-visibility family-lens rule now has a real home:
- AGENTS.md: the standing rule agents auto-discover (new media
  endpoints MUST thread the visible-library set; 403, never silently
  pass; history of the 2026-10-13 leak).
- docs/developer/library-visibility.md: the full explanation (helpers,
  SQL pattern, per-item content gates, series per-library), linked
  from the developer docs index.
Stale doc links updated (docs index, contributing, development).
2026-10-13 20:18:42 -04:00

1015 B

Contributing to Bookhoard

Welcome to the Bookhoard contributing documentation. This section contains guides for contributing to the Bookhoard project.

🚀 Getting Started

  • Development Guide - Development workflow and architecture
    • Architecture overview
    • Directory structure
    • Local development setup
    • Testing guidelines
    • Code style
    • Deployment

📋 Project Guidelines

  • AGENTS.md - Agent/development rules
    • Critical prohibitions
    • Mandatory requirements
    • Error recovery protocol
    • Workflow checklists

🤝 How to Contribute

We welcome contributions! Please see our Development Guide for information on:

  • Setting up your development environment
  • Understanding the codebase
  • Making pull requests
  • Code review process
  • Testing requirements

Looking for user documentation? See the User Portal Need API docs? See the Developer Portal