mirror of
https://github.com/harvard-edge/cs249r_book.git
synced 2026-03-12 02:06:14 -05:00
683ef7346b
- Created comprehensive issue branch workflow documentation
- Standardized branch naming: issue-{number}-{short-description}
- Defined commit message format with automatic issue linking
- Established GitHub automation keywords (Closes, Addresses, etc.)
- Added quick reference guide for daily use
- Ensures full traceability from issue to resolution
- Enables automatic issue closure through PR merges
This workflow will streamline our issue management and provide
complete audit trails for all textbook improvements.
1.2 KiB
1.2 KiB
Issue Workflow Quick Reference
🚀 Quick Start Commands
1. Start Working on Issue
git checkout dev && git pull origin dev
git checkout -b issue-{number}-{short-description}
2. Commit with Issue Reference
git commit -m "type(scope): description
- Change details
- Addresses #{number}"
3. Final Commit (Closes Issue)
git commit -m "type(scope): final description
- Final changes
- Closes #{number}"
4. Create PR
git push origin issue-{number}-{description}
gh pr create --title "Fix #{number}: {Title}" --body "Closes #{number}" --base dev
📋 Branch Naming Examples
issue-960-duplicate-efficiency-headingsissue-959-framework-components-duplicateissue-1001-broken-cross-references
🔗 GitHub Keywords
- Link only:
Addresses #123,References #123,Relates to #123 - Close issue:
Closes #123,Fixes #123,Resolves #123
✅ Commit Types
fix: Bug fixes, correctionsfeat: New features, contentdocs: Documentationrefactor: Restructuringstyle: Formatting
🎯 Remember
- Always branch from
dev - Use
--no-ffwhen merging - Include issue number in branch name
- Final commit should close the issue
- Test before creating PR