mirror of
https://github.com/lfnovo/open-notebook.git
synced 2026-10-19 09:13:16 +00:00
23b51faf9f
* docs: development docs match the codebase; add-a-provider playbook - architecture.md: rewritten as a ~110-line map verified against the code (processes, layout, data model from the migrations, graphs, model calls, background jobs); links the accurate topic pages - testing.md, api-reference.md, code-standards.md: rewritten from the real suite, the /api prefix and Bearer auth, and the actual error-handling pattern (no longer contradicts AGENTS.md) - change-playbooks.md: new "Add an AI provider" playbook (registry + the four hand-maintained copies + tests + docs, checked against #1443/#1444); fixes async nodes, command registration, polling paths, locale steps (LanguageToggle, satisfies TranslationShape), colocated frontend tests - development-setup.md is the single setup page (deps, .env with localhost SURREAL_URL, DB -> API -> worker -> frontend, real log lines, /health); quick-start.md and README.dev.md point to it - contributing.md: Conventional Commits, CHANGELOG rule, pre-PR checks that match CI; PR template gains ruff format and frontend checks - AGENTS files agree with the docs (provider edits, routers vs services, async nodes, checkpoint path, ADR-013, stop_on); api/AGENTS.md is a plain link instead of a Claude-only @ import - ADR index explains ADR-010 (reserved for #1332) and number-at-merge; GitHub-compatible encryption anchor; small credentials/security fixes Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs: address review (CI commands, async source creation, paths, ADR-010, language toggle) Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
33 lines
1.5 KiB
Markdown
33 lines
1.5 KiB
Markdown
# Contributing to Open Notebook
|
|
|
|
**📍 This file has moved!**
|
|
|
|
All contribution guidelines have been consolidated into the new development documentation structure.
|
|
|
|
👉 **[Read the Contributing Guide](docs/7-DEVELOPMENT/contributing.md)**
|
|
|
|
---
|
|
|
|
## Quick Links
|
|
|
|
- **Want to contribute code?** → [Contributing Guide](docs/7-DEVELOPMENT/contributing.md)
|
|
- **Want to understand the architecture?** → [Architecture Overview](docs/7-DEVELOPMENT/architecture.md)
|
|
- **Want to understand what we're building?** → [Vision & Principles](VISION.md)
|
|
- **Want to understand our engineering practices?** → [Design Principles](docs/7-DEVELOPMENT/design-principles.md)
|
|
- **Are you a maintainer?** → [Maintainer Guide](docs/7-DEVELOPMENT/maintainer-guide.md)
|
|
- **Setting up locally?** → [Development Setup](docs/7-DEVELOPMENT/development-setup.md)
|
|
|
|
---
|
|
|
|
## The Contribution Workflow
|
|
|
|
**TL;DR**: Feature requests, product/design/architecture proposals, and other non-trivial ideas
|
|
start in [GitHub Discussions](https://github.com/lfnovo/open-notebook/discussions/new?category=ideas).
|
|
Reproducible bugs start in Issues. Coding starts from an approved and assigned Issue. Small obvious
|
|
fixes (typos, docs, tiny bugs) can still go straight to a PR.
|
|
|
|
This prevents wasted effort and ensures your work aligns with the project. [See details →](docs/7-DEVELOPMENT/contributing.md)
|
|
|
|
---
|
|
|
|
For all contribution details, see **[docs/7-DEVELOPMENT/contributing.md](docs/7-DEVELOPMENT/contributing.md)**.
|