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>
2.0 KiB
2.0 KiB
team-guide
Working agreements for our team's AI-assisted ("vibe coding") development. Small team, English docs, opinionated but light.
What this repo is
A single source of truth for how we work, not what we build. It covers:
- How we use Claude Code (CLAUDE.md, permissions, hooks, memory, skills)
- How we collaborate with AI when writing code (vibe coding norms)
- Git workflow (branches, commits, PRs, review)
- Skill management and project planning rhythm
- Code & deliverable style (naming, comments, READMEs, task packages, handoffs)
Every doc is short. If a rule needs more than half a page to justify, it probably isn't a rule yet — it's a discussion.
Layout
team-guide/
├── README.md ← you are here
├── CLAUDE.md ← context Claude Code loads when working in this repo
├── docs/
│ ├── 01-vibe-coding.md ← how humans + AI split the work
│ ├── 02-claude-code.md ← CLAUDE.md / permissions / hooks / memory / skills
│ ├── 03-git-workflow.md ← branches, commits, PRs, review
│ ├── 04-skills-and-planning.md ← skill catalog + planning cadence
│ ├── 05-code-style.md ← naming, comments, structure
│ └── 06-handoff.md ← task packages, handoff checklists
└── templates/
├── CLAUDE.md.template
├── README.md.template
├── PR_DESCRIPTION.template.md
└── HANDOFF_CHECKLIST.template.md
How to use it
- New team member — read
docs/01-vibe-coding.mdanddocs/03-git-workflow.mdfirst. The rest is reference. - Starting a new project — copy the templates from
templates/into the new repo and fill them in. Drop a top-levelCLAUDE.mdthat points back here. - Disagreeing with a rule — open a PR against this repo. Don't silently diverge.
Versioning
This repo is versioned, not pinned. Read the latest main. Notable changes
get a CHANGELOG entry once we have one; until then, git log is the
changelog.
License
Internal.