Branch and Workflow Plan¶
← Previous
Repository Readiness Check
Current
Branch and Workflow Plan
Next →
Implementation Work Items
Template purpose¶
Use this template to define how implementation work moves through branches, commits, pull requests, reviews, and merges.
Project¶
<Project name>
Document control¶
| Field | Value |
|---|---|
| Artifact owner | <owner> |
| Primary reviewers | <reviewers> |
| Status | <draft / in review / accepted / revised> |
| Last updated | <YYYY-MM-DD> |
| Related Engineering Stage | ES-106 — Implementation Readiness |
| Project workspace target | docs/project-workspace/implementation/branch_and_workflow_plan.md |
Branch strategy¶
<branch strategy>
Branch naming¶
| Branch Type | Pattern | Example |
|---|---|---|
| Feature | <pattern> |
<example> |
| Fix | <pattern> |
<example> |
| Evidence / docs | <pattern> |
<example> |
| Experiment / spike | <pattern> |
<example> |
Commit expectations¶
<expectation>
Pull request expectations¶
| Requirement | Expectation |
|---|---|
| Work item reference | <IW-ID required?> |
| Source design reference | <design artifact required?> |
| Tests / checks | <expected checks> |
| Evidence update | <required evidence> |
| AI disclosure | <required if AI assisted> |
| Reviewer assignment | <reviewer rules> |
Merge criteria¶
<criterion>
Review requirements¶
| Review Area | Required Reviewer | Evidence |
|---|---|---|
| Functional behavior | <reviewer> |
<evidence> |
| Access control | <reviewer> |
<evidence> |
| Evidence-producing behavior | <reviewer> |
<evidence> |
| AI-assisted work | <reviewer> |
<evidence> |
| Security/privacy-sensitive work | <reviewer> |
<evidence> |
Emergency or exception workflow¶
<How urgent changes, hotfixes, or exceptions are handled without losing evidence.>
Review checklist¶
- [ ] Branch strategy is defined.
- [ ] Naming conventions are defined.
- [ ] Commit and PR expectations are clear.
- [ ] Merge criteria include review and evidence.
- [ ] AI-assisted work disclosure is addressed.
- [ ] Exceptions do not bypass evidence.