DEV-005 recommended Technical Documentation
Development workflow documented
New developers need to know team conventions: branching, PRs, reviews, deployments.
Question to ask
"Could a contractor submit a PR without asking anyone?"
Pass criteria
- ✓ Workflow doc exists
- ✓ Covers branching, PRs, reviews
- ✓ Commit conventions documented
- ✓ Deploy process explained
Fail criteria
- ✗ No workflow doc
- ✗ Incomplete coverage
- ✗ Contradicts actual practice
- ✗ New devs need to ask basics
Related items
Verification guide
Severity: Recommended
New developers need to know the team's conventions: how to branch, how to submit PRs, what reviews look like, how deployments work.
Check automatically:
# Look for contributing or workflow docs
find . -maxdepth 3 -type f \( -name "CONTRIBUTING*" -o -name "*workflow*" -o -name "*process*" -o -name "*conventions*" \) -name "*.md" 2>/dev/null | grep -v node_modules
# Search for workflow content
grep -riE "pull request|PR process|branch|commit|code review|merge|deploy" docs/ README.md CONTRIBUTING.md --include="*.md" 2>/dev/null | head -15
# Check for PR templates
ls -la .github/PULL_REQUEST_TEMPLATE* .github/pull_request_template* 2>/dev/null
Ask user:
- "Is the development workflow documented?" (branching, PRs, reviews, deploys)
- "Would a new dev know how to submit their first PR correctly?"
- "Are conventions documented?" (commit messages, branch naming)
Pass criteria:
- Workflow doc exists (CONTRIBUTING.md or equivalent)
- Covers: branching strategy, PR process, review expectations
- Commit message conventions documented
- Deploy process explained (or linked)
Fail criteria:
- No workflow doc ("just follow what others do")
- Doc exists but incomplete (branching yes, reviews no)
- Contradicts actual practice
- New dev would need to ask about basics
Cross-reference with:
- Section 9 (Development Workflow - FLOW items)
- GIT-004/005/006 (branch protection, strategy)
Evidence to capture:
- Location of workflow doc
- Topics covered (branching, PRs, reviews, commits, deploys)
- Whether PR template exists
- Alignment with actual practice