Working agreements for our 1-3 person AI-assisted team. Six docs (vibe coding, Claude Code, git workflow, skills/planning, code style, handoff) plus four templates (CLAUDE.md, README, PR description, handoff checklist). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
54 lines
996 B
Plaintext
54 lines
996 B
Plaintext
# CLAUDE.md — <project name>
|
|
|
|
<!--
|
|
Template. Copy into a new repo and fill the bracketed sections.
|
|
Delete sections that don't apply. Keep total length under ~100 lines.
|
|
-->
|
|
|
|
## What this project is
|
|
|
|
<One or two sentences. What does it do, who is it for.>
|
|
|
|
## Run it
|
|
|
|
```bash
|
|
# install
|
|
<command>
|
|
|
|
# run
|
|
<command>
|
|
|
|
# test
|
|
<command>
|
|
|
|
# lint / typecheck
|
|
<command>
|
|
```
|
|
|
|
## Architecture
|
|
|
|
<One paragraph. Where are the entry points, how does data flow, what
|
|
are the major modules. Skip diagrams unless they save words.>
|
|
|
|
Key files:
|
|
|
|
- `<path>` — <one-line role>
|
|
- `<path>` — <one-line role>
|
|
|
|
## Conventions specific to this repo
|
|
|
|
<Anything that's not obvious from reading the code. Naming patterns,
|
|
where to add new features, what's auto-generated, etc.>
|
|
|
|
## Don'ts
|
|
|
|
<Things Claude or a new contributor has gotten wrong before.
|
|
One line each. Add to this list as you discover them.>
|
|
|
|
- Don't <…>
|
|
- Don't <…>
|
|
|
|
## External resources
|
|
|
|
<Links to dashboards, related repos, docs, ticket trackers.>
|