chiron 0.2.0 → 0.2.2

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ee3cb5e4893ff687265d9e2d8d2fc75de956dd3abeca8b330e7f7c5f5d6c437a
4
- data.tar.gz: 0d53f562161301fa0093939a2eee2a3fa64c5f2a5a2c9f2802ecd31be12038f9
3
+ metadata.gz: b7dd7f387038865024e9723f8f4b7c6c631c04e2762085781c27b4cf86681c0e
4
+ data.tar.gz: 366fa17b95df84fcf300712f5ae9c1f377c9b02afbc9426dbd9784e9717b10f7
5
5
  SHA512:
6
- metadata.gz: '0183d1aa5e2fe30cd565e96ab8680b8cdb8c29066391942c641f2038c3ce0394f6ae6fd03c008ce211fc599b7e3773a429b48fb70115eaa268dd5b5942e27ae4'
7
- data.tar.gz: d7a016612648121ed2c031a0180c76637684285bc448f179d81850c8f85800a98964d346363e89d49d41c232d2c4a90f1178ff4606404478b85f06e99e60dafc
6
+ metadata.gz: 493cdba917d7250cf066ccae6d6ac3838581c3535aba36e28dc6e59aa5670ef125b8719122db4983795777e04ff4ad8cc74d762f6e558a5ff99cd20f06110a7f
7
+ data.tar.gz: 7f8125670a0dbaa4914bc81e8df9322c7447d50c24466681413addaeaef9d3fe9e120ff9d42e468b5a873b344bb54d9ca6a46c26888ef76c1af2f9d482b13238
data/CHANGELOG.md CHANGED
@@ -5,6 +5,33 @@ All notable changes to this project will be documented in this file.
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
+ ## [0.2.1] - 2025-07-01
9
+
10
+ ### Added
11
+
12
+ #### Branch Tracking for Claude Sessions
13
+ - **`/branch-context` Command**: Comprehensive branch information for Claude session continuity
14
+ - **Branch Management Workflow**: Complete procedures for creating, switching, and managing Git branches
15
+ - **Enhanced Context Commands**: Updated `/quickstart` and `/catchup` with branch awareness
16
+ - **Development Journal Integration**: Branch tracking sections and guidelines for documentation
17
+ - **Session Continuity**: Workflows for maintaining context across Claude sessions and branch switches
18
+
19
+ #### New Workflow Templates
20
+ - **Branch Context** (`shared/commands/context/branch-context.md`): Detailed branch information and progress tracking
21
+ - **Branch Management** (`shared/commands/workflows/branch-management.md`): Complete branch lifecycle management
22
+
23
+ #### Enhanced Documentation
24
+ - **CLAUDE.md**: Added branch management section with naming conventions and session continuity guidelines
25
+ - **Development Journal Template**: Enhanced with branch tracking fields and ownership documentation
26
+ - **Context Commands**: Integrated branch awareness into existing workflow commands
27
+
28
+ ### Enhanced
29
+
30
+ #### Session Management
31
+ - **Context Continuity**: Improved Claude session startup with branch context
32
+ - **Progress Tracking**: Better documentation of branch work and ownership
33
+ - **Collaboration**: Enhanced handoff procedures and shared understanding patterns
34
+
8
35
  ## [0.2.0] - 2025-07-01
9
36
 
10
37
  ### Added
data/CLAUDE.md CHANGED
@@ -98,11 +98,40 @@ lib/
98
98
  - Test CLI commands with temporary directories
99
99
  - Follow RSpec best practices
100
100
 
101
+ ## Branch Management and Claude Sessions
102
+
103
+ ### Branch Naming Conventions
104
+ - `feature/[description]` - New functionality (e.g., `feature/python-support`)
105
+ - `bugfix/[description]` - Bug fixes (e.g., `bugfix/template-loading`)
106
+ - `hotfix/[description]` - Urgent production fixes
107
+ - `experiment/[description]` - Exploratory work
108
+
109
+ ### Claude Session Continuity
110
+ - **Starting Sessions**: Always run `/quickstart` to get current context
111
+ - **Branch Work**: Use `/branch-context` when working on feature branches
112
+ - **Progress Tracking**: Update development journal for significant changes
113
+ - **Branch Switching**: Document current state before switching branches
114
+
115
+ ### Development Journal Usage
116
+ - Include branch name in all journal entries
117
+ - Update "Active Branches & Ownership" section when creating/merging branches
118
+ - Link journal entries to related PRD files
119
+ - Document architectural decisions and reasoning
120
+
121
+ ### Branch Workflow
122
+ 1. Create branch from updated main: `git checkout -b feature/description`
123
+ 2. Document branch purpose in development journal
124
+ 3. Make initial empty commit with context
125
+ 4. Develop with frequent commits and journal updates
126
+ 5. Use `/catchup` and `/branch-context` for status updates
127
+ 6. Complete pre-commit checklist before merging
128
+
101
129
  ## Important Reminders
102
130
 
103
131
  - Always run tests before committing
104
- - Use semantic commit messages
132
+ - Use semantic commit messages with branch context
105
133
  - Update the development journal for significant changes
106
134
  - Follow the pre-commit checklist in `.claude/commands/quality/pre-commit.md`
135
+ - Use branch management workflows for feature development
107
136
  - Update CHANGELOG.md for notable changes
108
137
  - Test gem building and installation locally before releasing
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- chiron (0.2.0)
4
+ chiron (0.2.1)
5
5
  colorize (~> 1.1)
6
6
  thor (~> 1.3)
7
7
  tty-prompt (~> 0.23)
@@ -1,11 +1,129 @@
1
1
  # Development Journal - Chiron Gem
2
2
 
3
3
  ## Project Overview
4
- Chiron is a Ruby gem that helps Rails developers set up Claude AI workflows, PRD templates, and development journaling systems.
4
+ Chiron is a Ruby gem that helps Rails and Python developers set up Claude AI workflows, PRD templates, and development journaling systems.
5
+
6
+ ---
7
+
8
+ ## 2025-07-01 - Enhancement: Claude Code Best Practices Integration
9
+ **Developer(s)**: Claude Code | **Branch**: main | **Context**: User research into Claude Code best practices
10
+
11
+ ### What was accomplished today:
12
+ - **Template Enhancement**: Updated Rails and Python CLAUDE.md templates with best practices from https://www.anthropic.com/engineering/claude-code-best-practices
13
+ - **Extended Thinking Integration**: Added "think" triggers to workflow templates for complex problem solving
14
+ - **Test Verification Focus**: Enhanced TDD template to emphasize test failure verification before implementation
15
+ - **New Workflow Templates**: Created comprehensive Explore-Plan-Code-Commit and Visual Iteration workflows
16
+ - **Tool Permissions Guidance**: Added tool customization sections to help developers manage Claude Code permissions
17
+ - **Documentation Improvements**: Added quick documentation tips and conversational Q&A guidance
18
+
19
+ ### Technical decisions made:
20
+ - **Incremental Enhancement**: Modified existing templates rather than replacing them to maintain backward compatibility
21
+ - **Best Practice Integration**: Incorporated structured workflows (Explore-Plan-Code-Commit) recommended by Anthropic
22
+ - **Visual Development Support**: Added dedicated workflow for screenshot-driven UI development
23
+ - **Test Quality Focus**: Enhanced TDD workflow to prevent test overfitting and ensure proper failure verification
24
+
25
+ ### Implementation details:
26
+ - **Updated Templates**: Both `rails/CLAUDE.md.erb` and `python/CLAUDE.md.erb` now include tool permissions, extended thinking, and visual development guidance
27
+ - **New Workflow Files**:
28
+ - `explore-plan-code-commit.md` - Structured development process
29
+ - `visual-iteration.md` - Screenshot-driven UI development
30
+ - **Enhanced TDD**: Updated `test-driven.md` with failure verification and overfitting prevention
31
+ - **Quality Assurance**: All 41 tests continue to pass, ensuring no breaking changes
32
+
33
+ ### Files modified:
34
+ - `lib/chiron/templates/rails/CLAUDE.md.erb` - Added best practices sections
35
+ - `lib/chiron/templates/python/CLAUDE.md.erb` - Added best practices sections
36
+ - `lib/chiron/templates/shared/commands/workflows/create-prd.md` - Added extended thinking trigger
37
+ - `lib/chiron/templates/shared/commands/quality/test-driven.md` - Enhanced with failure verification
38
+ - `lib/chiron/templates/shared/commands/workflows/explore-plan-code-commit.md` - New comprehensive workflow
39
+ - `lib/chiron/templates/shared/commands/workflows/visual-iteration.md` - New UI development workflow
40
+
41
+ ---
42
+
43
+ ## 2025-07-01 - Major Enhancement: Comprehensive Python Project Support
44
+ **Developer(s)**: Claude Code | **Branch**: main | **Context**: User request for Python support
45
+
46
+ ### What was accomplished today:
47
+ - **Major Feature Release**: Added complete Python project support to Chiron gem
48
+ - **Framework Detection**: Implemented auto-detection for Django, FastAPI, Flask, and generic Python projects
49
+ - **Architecture Overhaul**: Created `ProjectConfig` class for language-agnostic tool management
50
+ - **Template Reorganization**: Restructured templates into `rails/`, `python/`, and `shared/` directories
51
+ - **Comprehensive Testing**: Expanded test suite from 5 to 41 tests with full Python coverage
52
+ - **Documentation Update**: Enhanced README, CHANGELOG, and CLI help with Python examples
53
+ - **RubyGems Publication**: Successfully published version 0.2.0 to RubyGems
54
+
55
+ ### Technical decisions made:
56
+ - **Multi-Language Architecture**: Designed extensible system supporting both Rails and Python
57
+ - **Project Detection**: Auto-detects project type via `requirements.txt`, `pyproject.toml`, `setup.py`, `Pipfile`
58
+ - **Framework Intelligence**: Identifies Django (`manage.py`), FastAPI/Flask (via requirements analysis)
59
+ - **Template Strategy**: Shared workflows with language-specific conventions and patterns
60
+ - **Backward Compatibility**: Maintained 100% compatibility with existing Rails functionality
61
+ - **Configuration Management**: `ProjectConfig` class abstracts tool selection (pytest vs RSpec, black vs RuboCop)
62
+
63
+ ### Features added:
64
+ - **Python CLI Options**: `--type=python`, `--with-django`, `--with-fastapi` flags
65
+ - **Smart Project Detection**: Interactive prompts for unknown project types
66
+ - **Python Workflow Templates**:
67
+ - Python Conventions (PEP 8, type hints, async patterns, framework best practices)
68
+ - Python Testing (pytest patterns, fixtures, mocking, async testing, CI/CD)
69
+ - Python Debugging (pdb workflows, logging strategies, performance profiling)
70
+ - Python Refactoring (SOLID principles, design patterns, code organization)
71
+ - Flask Development (blueprints, forms, testing, deployment patterns)
72
+ - **Framework-Specific Content**: Dynamic CLAUDE.md templates based on detected frameworks
73
+ - **Project-Specific Tips**: Contextual setup guidance after initialization
74
+
75
+ ### Code quality metrics:
76
+ - **RSpec**: 41 examples, 0 failures (8x increase in test coverage)
77
+ - **New Test Categories**: Framework detection, ProjectConfig functionality, Python workflows
78
+ - **RuboCop**: 29 minor offenses (mostly method length in CLI - acceptable for feature-rich CLI)
79
+ - **Backward Compatibility**: All existing Rails tests continue to pass
80
+
81
+ ### Architecture improvements:
82
+ - **Template Structure**:
83
+ ```
84
+ lib/chiron/templates/
85
+ ├── rails/ # Rails-specific templates
86
+ ├── python/ # Python-specific templates
87
+ └── shared/ # Language-agnostic workflows
88
+ ```
89
+ - **Language Detection**: Robust project type identification with fallback mechanisms
90
+ - **Tool Configuration**: Abstracted command generation for testing, linting, formatting
91
+ - **ERB Enhancement**: Framework-aware template rendering with conditional content
92
+
93
+ ### Bugs fixed:
94
+ - **Template Fallbacks**: Graceful handling when project-specific templates don't exist
95
+ - **CLI Robustness**: Improved error handling for unknown project types
96
+ - **Cross-Platform**: Ensured Python detection works across different package managers
97
+
98
+ ### Version and release:
99
+ - **Version Bump**: 0.1.0 → 0.2.0 (major feature enhancement)
100
+ - **Gem Build**: Successfully built `chiron-0.2.0.gem`
101
+ - **RubyGems**: Published to RubyGems registry
102
+ - **Documentation**: Comprehensive CHANGELOG with technical details
103
+
104
+ ### Impact and usage:
105
+ - **Multi-Language Support**: Chiron now serves both Rails and Python ecosystems
106
+ - **Framework Coverage**: Django, FastAPI, Flask, and generic Python projects supported
107
+ - **Developer Experience**: Auto-detection eliminates manual configuration
108
+ - **Workflow Richness**: Language-specific best practices and patterns included
109
+
110
+ ### Next steps:
111
+ - Monitor RubyGems adoption and user feedback
112
+ - Consider additional language support (Node.js, Go, etc.)
113
+ - Enhance framework detection with more sophisticated analysis
114
+ - Add more Python-specific workflow templates based on community needs
115
+ - Create video documentation showing Python project initialization
116
+
117
+ ### Notes:
118
+ - This represents the largest enhancement to Chiron since its creation
119
+ - Successfully maintained backward compatibility while adding major new functionality
120
+ - Python support is comprehensive and production-ready
121
+ - Architecture now supports easy addition of future languages
5
122
 
6
123
  ---
7
124
 
8
125
  ## 2025-01-21 - Initial Setup and Module Rename
126
+ **Developer(s)**: Claude Code | **Branch**: main | **Context**: Initial gem development
9
127
 
10
128
  ### What was accomplished today:
11
129
  - Set up complete gem development infrastructure
@@ -6,6 +6,17 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
6
6
 
7
7
  <%= @project_name %> is a Python project<% if @python_framework == :django %> using Django framework<% elsif @python_framework == :fastapi %> using FastAPI framework<% elsif @python_framework == :flask %> using Flask framework<% end %>. [Add your project description here]
8
8
 
9
+ ## Tool Permissions & Customization
10
+
11
+ ```bash
12
+ # View current tool permissions
13
+ /permissions
14
+
15
+ # Customize tools for specific sessions
16
+ claude --allowedTools read,edit,bash --no-write # Example: read-only session
17
+ claude --allowedTools bash,read,write # Example: development session
18
+ ```
19
+
9
20
  ## Development Commands
10
21
 
11
22
  **Important**: Use virtual environments for dependency isolation.
@@ -118,6 +129,17 @@ JWT_SECRET=your-jwt-secret
118
129
 
119
130
  ## Development Patterns
120
131
 
132
+ ### Explore-Plan-Code-Commit Workflow
133
+ 1. **Explore**: Read relevant files and understand context
134
+ 2. **Plan**: Use "think" to trigger extended thinking mode for complex problems
135
+ 3. **Code**: Implement solution incrementally with frequent testing
136
+ 4. **Commit**: Create clear commit messages explaining the change
137
+
138
+ ### Visual Development
139
+ - Take screenshots for UI work using Claude Code's image reading
140
+ - Iterate 2-3 times for visual improvements
141
+ - Use incremental screenshots to track progress
142
+
121
143
  ### Code Organization
122
144
  <% if @python_framework == :django %>
123
145
  - Follow Django's app-based architecture
@@ -150,9 +172,10 @@ JWT_SECRET=your-jwt-secret
150
172
  ## Testing Standards
151
173
 
152
174
  - Write tests before implementation (TDD)
175
+ - **Verify tests fail first** - Confirm tests fail before writing implementation
153
176
  - Use pytest fixtures for test data
154
177
  - Mock external dependencies
155
- - Aim for high test coverage
178
+ - Aim for high test coverage but avoid "overfitting to the tests"
156
179
  - Test edge cases and error conditions
157
180
 
158
181
  <% if @python_framework == :django %>
@@ -182,11 +205,19 @@ def test_read_main():
182
205
  ```
183
206
  <% end %>
184
207
 
208
+ ## Quick Documentation Tips
209
+
210
+ - Use `#` key to quickly document guidelines and patterns
211
+ - Be specific in instructions to Claude
212
+ - Course-correct early and often during development
213
+ - Provide clear context and expectations
214
+
185
215
  ## Important Reminders
186
216
 
187
217
  - Always run tests before committing
188
- - Use semantic commit messages
218
+ - Use semantic commit messages with clear explanations
189
219
  - Update the development journal for significant changes
190
220
  - Follow the pre-commit checklist in `.claude/commands/quality/pre-commit.md`
191
221
  - Keep dependencies updated in requirements.txt
192
- - Document API changes
222
+ - Document API changes
223
+ - Use conversational Q&A to explore unfamiliar parts of the codebase