mirror of
https://github.com/NanmiCoder/cc-haha
synced 2026-07-16 13:03:31 +08:00
Contributors need a visible path for local verification instead of relying on design notes or maintainer memory. Add a GitHub-facing CONTRIBUTING entrypoint, bilingual docs pages, README links, and VitePress sidebar navigation for PR gates, live model baselines, provider selection, reports, and release checks. Constraint: Live baseline providers are local machine state; docs must tell contributors how to list and choose their own providers without maintainer UUIDs. Rejected: Keep the instructions only in the quality-gate design doc | too hidden for clone-and-contribute workflows Confidence: high Scope-risk: narrow Directive: Keep quality-gate commands documented wherever contributor onboarding links are exposed. Tested: bun run check:docs Tested: bun run quality:pr Not-tested: live baseline after the docs-only wording change
32 lines
957 B
Markdown
32 lines
957 B
Markdown
# Contributing
|
|
|
|
Thanks for helping improve Claude Code Haha.
|
|
|
|
For the full contributor guide, including local checks, live model baselines, quality-gate reports, and PR expectations, see:
|
|
|
|
- Chinese: [docs/guide/contributing.md](docs/guide/contributing.md)
|
|
- English: [docs/en/guide/contributing.md](docs/en/guide/contributing.md)
|
|
|
|
Most contributors should run this before opening a PR:
|
|
|
|
```bash
|
|
bun install
|
|
bun run quality:pr
|
|
```
|
|
|
|
If you run adapter or native checks on a fresh clone, install adapter dependencies too:
|
|
|
|
```bash
|
|
cd adapters
|
|
bun install
|
|
```
|
|
|
|
If your change touches the desktop chat path, provider/runtime selection, CLI bridge, permissions, tools, file editing, or release packaging, also run a live baseline with your own local model provider:
|
|
|
|
```bash
|
|
bun run quality:providers
|
|
bun run quality:gate --mode baseline --allow-live --provider-model <selector>:main
|
|
```
|
|
|
|
Quality reports are written under `artifacts/quality-runs/<timestamp>/`.
|