docs: make CONTRIBUTING the single contributor guide

This commit is contained in:
shumeiko.it
2026-11-04 10:41:40 +01:00
parent de9adcb03d
commit b11bdb8029
5 changed files with 11 additions and 344 deletions

View File

@@ -2,11 +2,8 @@
Thank you for helping. This page covers the setup, the checks and how to propose a change.
**Read [AGENTS.md](AGENTS.md) before you change code.** It is the operating contract for this
repository, for people and coding agents alike: what is in scope, the rules that must not be
broken, and the commands that verify a change. The decisions behind it are in
[docs/oss/adr/](docs/oss/adr/README.md). [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) explains
how the parts fit together.
[docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) explains how the parts fit together. The rules
below are the ones reviews check first.
## Prerequisites
@@ -45,7 +42,7 @@ Other entry points:
```bash
npm run dev -w @waggle/cli # terminal REPL on the same memory and waggle.db
(cd app && npm ci && npm run tauri:build:mac:arm64) # desktop app; see AGENTS.md section 4
(cd app && npm ci && npm run tauri:build:mac:arm64) # desktop app; also tauri:build:mac:x64, :win, :linux
```
## Checks
@@ -77,7 +74,6 @@ root `tests/`. New behavior needs a test; a bug fix needs a test that fails with
## Rules that reviews check first
The full list is in [AGENTS.md](AGENTS.md), section 3. In short:
- No monetization: no tiers, trials, payments, license checks or upsell.
- Memory goes through `MemoryStore` from `@waggle/memory-contract`. No SQL against a memory
@@ -89,8 +85,8 @@ The full list is in [AGENTS.md](AGENTS.md), section 3. In short:
- Analytics stay opt-in. Never commit a PostHog key or any other secret.
- Platform-specific code needs Windows, macOS and Linux paths. End users must not need Python,
Docker, a compiler or a developer Node.js install.
- Security constraints (secrets in the vault, the injection scanner on external input, no
`eval`, an explicit Tauri IPC allowlist, parameterized SQL) are in AGENTS.md, section 8.
- Security: secrets live in the vault, external input goes through the injection scanner, no
`eval`, the Tauri IPC allowlist stays explicit, and SQL is parameterized.
## Code style
@@ -98,8 +94,7 @@ The full list is in [AGENTS.md](AGENTS.md), section 3. In short:
`import type` for types.
- File names in `kebab-case.ts`; React components in `PascalCase.tsx`.
- Match the style of the file you change. Do not reformat code you do not otherwise touch.
- Search before you add a file: [AGENTS.md](AGENTS.md), section 9, lists modules that already
exist.
- Search before you add a file: the module you need may already exist.
- Code, comments, commit messages and documentation are in English. Write plainly.
## Commits and pull requests