Skip to content

Development and Contribution Guide

Use this guide when you develop BucketReef, contribute changes, understand its architecture, maintain CI/releases, or work on project documentation.

Scope

  • Architecture, principles, identity/execution model, and workspace boundaries.
  • Backend, frontend, database, API, and implementation reference.
  • Local development, testing, fixtures, and authenticated UI workflows.
  • Contribution and AI-assistant guardrails.
  • CI/CD, release engineering, and static demo maintenance.
  • Product-design and frontend implementation conventions.
  • Documentation architecture and maintenance.

This guide is about developing BucketReef itself. An application developer who only needs to provision and use S3 storage should start in the Manager guide instead.

  1. Architecture overview
  2. Principles
  3. AI assistant guidelines
  4. Identity and execution model
  5. Workspace surface separation
  6. Product design guidelines
  7. Local development
  8. Authenticated UI access for AI agents
  9. First contribution
  10. UI theme guidelines
  11. Docs maintenance

The static interactive demo documents the local simulation, coverage boundaries, browser tests and release-gated publication.