chiron 0.2.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,256 @@
1
+ # Branch Management Workflow
2
+
3
+ Comprehensive workflow for creating, switching, and managing Git branches in Claude Code sessions.
4
+
5
+ ## Creating New Branches
6
+
7
+ ### 1. **Pre-Branch Planning**
8
+ Before creating a branch, ensure:
9
+ - [ ] Clear understanding of the feature/fix purpose
10
+ - [ ] Related PRD exists (if for new feature)
11
+ - [ ] No existing branch covers the same work
12
+ - [ ] Clean working directory on current branch
13
+
14
+ ### 2. **Branch Creation Process**
15
+ ```bash
16
+ # Ensure you're on the base branch (usually main)
17
+ git checkout main
18
+ git pull origin main
19
+
20
+ # Create and switch to new branch
21
+ git checkout -b [type]/[descriptive-name]
22
+
23
+ # Examples:
24
+ git checkout -b feature/user-authentication
25
+ git checkout -b bugfix/login-validation
26
+ git checkout -b hotfix/security-patch
27
+ git checkout -b experiment/new-ui-approach
28
+ ```
29
+
30
+ ### 3. **Branch Documentation**
31
+ Immediately after creating a branch:
32
+
33
+ #### Update Development Journal
34
+ Add to the "Active Branches & Ownership" section:
35
+ ```markdown
36
+ - `feature/user-authentication`: [Your Name] - Implement user login/signup system - [Created 2025-07-01]
37
+ - **PRD**: tasks/prd-user-authentication.md
38
+ - **Dependencies**: None
39
+ - **Timeline**: 1 week
40
+ ```
41
+
42
+ #### Create Initial Commit
43
+ ```bash
44
+ # Create a planning commit to establish branch purpose
45
+ git commit --allow-empty -m "Start feature/user-authentication
46
+
47
+ Initial branch creation for implementing user authentication system.
48
+
49
+ Related PRD: tasks/prd-user-authentication.md
50
+ Estimated timeline: 1 week
51
+ Dependencies: None"
52
+ ```
53
+
54
+ ## Branch Switching Workflow
55
+
56
+ ### 1. **Before Switching Away**
57
+ ```bash
58
+ # Save current work
59
+ git add .
60
+ git commit -m "WIP: [describe current state]"
61
+ # OR
62
+ git stash push -m "Work in progress: [description]"
63
+
64
+ # Update journal with progress
65
+ # Run catchup command to document current state
66
+ ```
67
+
68
+ ### 2. **Switching to Different Branch**
69
+ ```bash
70
+ # Switch to target branch
71
+ git checkout [target-branch]
72
+
73
+ # Get branch context (use branch-context command)
74
+ # Update Claude with current branch state
75
+ ```
76
+
77
+ ### 3. **After Switching**
78
+ - [ ] Run `/branch-context` command to orient Claude
79
+ - [ ] Review recent commits and current state
80
+ - [ ] Check for any merge conflicts or issues
81
+ - [ ] Resume work from where you left off
82
+
83
+ ## Branch Maintenance
84
+
85
+ ### 1. **Regular Synchronization**
86
+ ```bash
87
+ # Keep feature branch updated with main
88
+ git checkout main
89
+ git pull origin main
90
+ git checkout [your-branch]
91
+ git merge main
92
+ # OR for cleaner history:
93
+ git rebase main
94
+ ```
95
+
96
+ ### 2. **Progress Tracking**
97
+ Update development journal regularly:
98
+ - When completing major milestones
99
+ - When encountering significant challenges
100
+ - When changing approach or design
101
+ - Before long breaks in development
102
+
103
+ ### 3. **Pre-Merge Checklist**
104
+ Before merging or creating PR:
105
+ - [ ] All tests passing
106
+ - [ ] Code quality checks pass
107
+ - [ ] Documentation updated
108
+ - [ ] Journal entry completed
109
+ - [ ] Branch purpose fully achieved
110
+ - [ ] No debug code or temporary changes
111
+
112
+ ## Claude Session Continuity
113
+
114
+ ### Starting New Session
115
+ When beginning a Claude session:
116
+ 1. Run `/quickstart` command
117
+ 2. Run `/branch-context` command
118
+ 3. Review recent journal entries
119
+ 4. Check current task status
120
+
121
+ ### During Development
122
+ - Use `/catchup` to summarize progress
123
+ - Update journal for significant changes
124
+ - Create meaningful commit messages
125
+ - Reference related PRDs or issues
126
+
127
+ ### Ending Session
128
+ Before ending a Claude session:
129
+ 1. Commit or stash current work
130
+ 2. Update journal with progress
131
+ 3. Note any blockers or next steps
132
+ 4. Create TODO items if applicable
133
+
134
+ ## Branch Types and Naming
135
+
136
+ ### Feature Branches
137
+ ```bash
138
+ feature/[short-description]
139
+ feature/user-authentication
140
+ feature/payment-integration
141
+ feature/admin-dashboard
142
+ ```
143
+ - For new functionality
144
+ - Usually based on PRDs
145
+ - Timeline: days to weeks
146
+
147
+ ### Bugfix Branches
148
+ ```bash
149
+ bugfix/[issue-description]
150
+ bugfix/login-validation
151
+ bugfix/email-formatting
152
+ bugfix/mobile-layout
153
+ ```
154
+ - For fixing existing functionality
155
+ - Should include issue reproduction
156
+ - Timeline: hours to days
157
+
158
+ ### Hotfix Branches
159
+ ```bash
160
+ hotfix/[urgent-issue]
161
+ hotfix/security-patch
162
+ hotfix/production-error
163
+ hotfix/data-corruption
164
+ ```
165
+ - For urgent production fixes
166
+ - Fast-tracked through review
167
+ - Timeline: hours
168
+
169
+ ### Experiment Branches
170
+ ```bash
171
+ experiment/[exploration-area]
172
+ experiment/new-ui-framework
173
+ experiment/performance-optimization
174
+ experiment/alternative-approach
175
+ ```
176
+ - For trying new approaches
177
+ - May not be merged
178
+ - Timeline: varies
179
+
180
+ ## Collaboration Patterns
181
+
182
+ ### Multiple Developers
183
+ - Update journal with developer assignments
184
+ - Use PR descriptions to communicate context
185
+ - Reference branch dependencies clearly
186
+ - Coordinate merge timing
187
+
188
+ ### Code Reviews
189
+ - Include branch context in PR description
190
+ - Reference related journal entries
191
+ - Explain design decisions made during development
192
+ - Link to relevant PRD sections
193
+
194
+ ### Handoffs
195
+ When transferring work to another developer:
196
+ 1. Complete journal entry for current state
197
+ 2. Commit all work with clear messages
198
+ 3. Document any known issues or blockers
199
+ 4. Update branch ownership in journal
200
+
201
+ ## Troubleshooting Common Issues
202
+
203
+ ### Lost Context
204
+ If Claude loses branch context:
205
+ 1. Run `/branch-context` command
206
+ 2. Review recent commits: `git log --oneline -10`
207
+ 3. Check journal for recent entries
208
+ 4. Summarize current work state
209
+
210
+ ### Merge Conflicts
211
+ ```bash
212
+ # Resolve conflicts step by step
213
+ git status # See conflicted files
214
+ git diff # Review conflicts
215
+ # Edit files to resolve conflicts
216
+ git add [resolved-files]
217
+ git commit -m "Resolve merge conflicts"
218
+ ```
219
+
220
+ ### Stale Branches
221
+ For branches behind main:
222
+ ```bash
223
+ git checkout [your-branch]
224
+ git fetch origin
225
+ git merge origin/main
226
+ # OR for cleaner history:
227
+ git rebase origin/main
228
+ ```
229
+
230
+ ## Best Practices Summary
231
+
232
+ ### Branch Creation
233
+ - Always create from updated main/develop
234
+ - Use descriptive, consistent naming
235
+ - Document purpose immediately
236
+ - Create empty initial commit with context
237
+
238
+ ### Development
239
+ - Commit frequently with meaningful messages
240
+ - Update journal for significant progress
241
+ - Keep branches focused on single purpose
242
+ - Sync with main regularly
243
+
244
+ ### Claude Integration
245
+ - Use context commands at session start
246
+ - Maintain journal throughout development
247
+ - Reference branch work in commits
248
+ - Document decisions and rationale
249
+
250
+ ### Cleanup
251
+ - Delete merged branches promptly
252
+ - Archive experiment branches with notes
253
+ - Update journal when closing branches
254
+ - Remove stale branch references
255
+
256
+ This workflow ensures branch work is well-documented, trackable across Claude sessions, and maintains clear development history.
@@ -8,12 +8,18 @@ This journal tracks significant development work, bug fixes, and feature impleme
8
8
 
9
9
  ## Active Branches & Ownership
10
10
  - `main`: Stable branch for production releases
11
- - `[feature-branch]`: [Developer Name] - [Feature description]
11
+ - `[feature-branch]`: [Developer Name] - [Feature description] - [Created YYYY-MM-DD]
12
+
13
+ ### Branch Tracking Guidelines
14
+ - Always update this section when creating/merging branches
15
+ - Include branch purpose, owner, and creation date
16
+ - Link to related PRD files when applicable
17
+ - Note dependencies between branches
12
18
 
13
19
  ---
14
20
 
15
21
  ## <%= Date.today.strftime('%Y-%m-%d') %> - Initial Setup
16
- **Developer(s)**: [Your Name] & Claude Code | **Context**: Project initialization
22
+ **Developer(s)**: [Your Name] & Claude Code | **Branch**: main | **Context**: Project initialization
17
23
 
18
24
  ### What Was Done
19
25
  - Initialized Rails <%= Rails.version rescue "8.0.2" %> application
@@ -51,7 +57,7 @@ This journal tracks significant development work, bug fixes, and feature impleme
51
57
  Journal Entry Template - Copy for new entries:
52
58
 
53
59
  ## [YYYY-MM-DD] - [Brief Summary Title]
54
- **Developer(s)**: [Name] | **Context**: [How work was initiated]
60
+ **Developer(s)**: [Name] | **Branch**: [branch-name] | **Context**: [How work was initiated]
55
61
 
56
62
  ### What Was Done
57
63
  - [Specific actions taken]
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Chiron
4
- VERSION = '0.2.0'
4
+ VERSION = '0.2.1'
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: chiron
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 0.2.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Brett McHargue
@@ -133,9 +133,14 @@ files:
133
133
  - lib/chiron/project_config.rb
134
134
  - lib/chiron/templates/python/CLAUDE.md.erb
135
135
  - lib/chiron/templates/python/commands/conventions/python.md
136
+ - lib/chiron/templates/python/commands/quality/python-testing.md
137
+ - lib/chiron/templates/python/commands/workflows/debug-python.md
138
+ - lib/chiron/templates/python/commands/workflows/flask-development.md
139
+ - lib/chiron/templates/python/commands/workflows/python-refactor.md
136
140
  - lib/chiron/templates/rails/CLAUDE.md.erb
137
141
  - lib/chiron/templates/rails/commands/conventions/rails.md
138
142
  - lib/chiron/templates/shared/claude/settings.json
143
+ - lib/chiron/templates/shared/commands/context/branch-context.md
139
144
  - lib/chiron/templates/shared/commands/context/catchup.md
140
145
  - lib/chiron/templates/shared/commands/context/prime.md
141
146
  - lib/chiron/templates/shared/commands/context/quickstart.md
@@ -143,6 +148,7 @@ files:
143
148
  - lib/chiron/templates/shared/commands/journal/template.md
144
149
  - lib/chiron/templates/shared/commands/quality/pre-commit.md
145
150
  - lib/chiron/templates/shared/commands/quality/test-driven.md
151
+ - lib/chiron/templates/shared/commands/workflows/branch-management.md
146
152
  - lib/chiron/templates/shared/commands/workflows/create-prd.md
147
153
  - lib/chiron/templates/shared/commands/workflows/feature-complete.md
148
154
  - lib/chiron/templates/shared/commands/workflows/generate-tasks.md