Establishes contributor guidelines based on maintainer team discussion. VISION.md defines project identity, principles, and explicit rejection criteria. CONTRIBUTING.md covers assign-then-PR workflow, RFC process for architectural changes, AI disclosure policy, and testing standards. PR template restructured around TL;DR + What/Why/How format. Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
52 lines
1.3 KiB
Markdown
52 lines
1.3 KiB
Markdown
## TL;DR
|
|
|
|
**What:** <!-- One sentence — what does this change? -->
|
|
**Why:** <!-- One sentence — why is it needed? -->
|
|
**How:** <!-- One sentence — what's the approach? -->
|
|
|
|
## What
|
|
|
|
<!-- Detailed description of the change. What files, modules, or systems are affected? -->
|
|
|
|
## Why
|
|
|
|
<!-- The motivation. What problem does this solve? Link issues: Closes #123 -->
|
|
|
|
## How
|
|
|
|
<!-- The approach. How does the implementation work? Key decisions and alternatives considered? -->
|
|
|
|
## Change type
|
|
|
|
- [ ] `feat` — New feature or capability
|
|
- [ ] `fix` — Bug fix
|
|
- [ ] `refactor` — Code restructuring (no behavior change)
|
|
- [ ] `test` — Adding or updating tests
|
|
- [ ] `docs` — Documentation only
|
|
- [ ] `chore` — Build, CI, or tooling changes
|
|
|
|
## Scope
|
|
|
|
- [ ] `pi-tui` — Terminal UI
|
|
- [ ] `pi-ai` — AI/LLM layer
|
|
- [ ] `pi-agent-core` — Agent orchestration
|
|
- [ ] `pi-coding-agent` — Coding agent
|
|
- [ ] `gsd extension` — GSD workflow
|
|
- [ ] `native` — Native bindings
|
|
- [ ] `ci/build` — Workflows, scripts, config
|
|
|
|
## Breaking changes
|
|
|
|
- [ ] No breaking changes
|
|
- [ ] Yes — described above
|
|
|
|
## Test plan
|
|
|
|
- [ ] CI passes
|
|
- [ ] New/updated tests included
|
|
- [ ] Manual testing — steps described above
|
|
- [ ] No tests needed — explained above
|
|
|
|
## AI disclosure
|
|
|
|
- [ ] This PR includes AI-assisted code <!-- If so, note the tool and what was tested -->
|