wry 0.5.1.dev3__tar.gz → 0.5.1.dev5__tar.gz

{wry-0.5.1.dev3 → wry-0.5.1.dev5}/.cursorrules

@@ -7,10 +7,10 @@
 
 Before making any commit, AI assistants MUST:
 
-1. **Update Documentation**:
+1. **Update Documentation** (ALWAYS update CHANGELOG.md):
+   - **CHANGELOG.md**: ALWAYS add entry under [Unreleased] for ANY change
    - README.md if user-facing changes
    - AI_KNOWLEDGE_BASE.md if architecture/API changes
-   - CHANGELOG.md with entry under [Unreleased]
    - Module docstrings if relevant
 
 2. **Ensure Code Quality**:
@@ -29,7 +29,12 @@ Before making any commit, AI assistants MUST:
    - Fix linter errors (ruff, mypy)
    - Format code properly (ruff format)
 
-5. **Follow Conventional Commits**:
+5. **Update TODO.md** (if applicable):
+   - Mark completed tasks as done
+   - Remove completed items or move to archive section
+   - Update progress on ongoing work
+
+6. **Follow Conventional Commits**:
    - Use format: `type: description`
    - Types: feat, fix, docs, refactor, test, chore, build
 
@@ -49,6 +54,7 @@ Before making any commit, AI assistants MUST:
 - Code patterns: `CONTRIBUTING.md` "Configuration Models" section
 - Testing guide: `CONTRIBUTING.md` "Testing" section
 - Pre-commit checklist: `CONTRIBUTING.md` "Pre-Commit Checklist" section
+- Release workflow: `RELEASE_PROCESS.md` for creating releases
 
 ## Enforcement
 

{wry-0.5.1.dev3 → wry-0.5.1.dev5}/AI_KNOWLEDGE_BASE.md

@@ -1,9 +1,16 @@
 # wry - Comprehensive AI/LLM Knowledge Base
 
-**Last Updated**: 2025-10-04
-**Version**: 0.3.2+
+**Last Updated**: 2025-10-14
+**Version**: 0.5.0+
 **Purpose**: Complete reference for AI assistants and LLMs to understand wry without reading the entire codebase
 
+**Related Documentation**:
+- 📖 **`CONTRIBUTING.md`** - Comprehensive contributor guide (referenced by `.cursorrules`)
+- 🤖 **`.cursorrules`** - AI assistant quick reference (references this file and CONTRIBUTING.md)
+- 📘 **`README.md`** - User-facing documentation
+- 📝 **`CHANGELOG.md`** - Version history and changes
+- 🚀 **`RELEASE_PROCESS.md`** - Release workflow (how to convert [Unreleased] → [X.Y.Z])
+
 ---
 
 ## Executive Summary
@@ -19,7 +26,9 @@
 
 **Key Innovation**: Single source of truth for configuration with comprehensive source tracking.
 
-**Stats**: 436 tests (all passing), 92%+ coverage, supports Python 3.10-3.12, Pydantic v2.11+ compatible
+**Stats**: 494 tests (all passing), 92%+ coverage, supports Python 3.10-3.12, Pydantic v2.11+ compatible
+
+**For Contributors**: See `CONTRIBUTING.md` for development guidelines and `.cursorrules` for AI assistant rules
 
 ---
 
@@ -2814,19 +2823,29 @@ Single source of truth: Pydantic model defines everything.
 - ✅ Multi-source configuration (CLI/ENV/JSON/DEFAULT)
 - ✅ Source tracking (know where every value came from)
 - ✅ Type safety (Pydantic + Click)
-- ✅ Comprehensive testing (407 tests, 92% coverage)
-- ✅ Excellent documentation (README + AI KB + examples)
+- ✅ Comprehensive testing (494 tests, 92% coverage)
+- ✅ Excellent documentation (README + AI KB + examples + CONTRIBUTING)
 
 **For AI assistants**:
 
-- Start with `examples/source_tracking_comprehensive.py` to understand the system
-- Reference this knowledge base for details
-- Check version for bug fixes (v0.2.2 critical)
+- **Follow** `.cursorrules` for quick development rules
+- **Reference** this knowledge base (AI_KNOWLEDGE_BASE.md) for technical details
+- **Check** `CONTRIBUTING.md` for complete development guidelines
+- Start with comprehensive examples to understand the system
+- Check version for bug fixes (v0.2.2 critical, v0.5.0 adds list support)
 - Point users to examples for patterns
 - Use `show_help_index()` to help users find documentation
 
+**For Contributors**:
+
+- **Read** `CONTRIBUTING.md` for complete guidelines
+- **Follow** `.cursorrules` if using Cursor AI
+- **Reference** this knowledge base for architecture details
+- **Check** `CHANGELOG.md` for version history
+- **See** `RELEASE_PROCESS.md` for creating releases
+
 ---
 
-**End of Knowledge Base** - Version 0.2.3+ - Last Updated: 2025-10-01
+**End of Knowledge Base** - Version 0.5.0+ - Last Updated: 2025-10-14
 
 **Access this**: `python -m wry.help_system ai` or `from wry import print_help; print_help('ai')`

{wry-0.5.1.dev3 → wry-0.5.1.dev5}/CHANGELOG.md

@@ -15,6 +15,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - `.cursorrules` references `CONTRIBUTING.md` for detailed explanations
   - Both tailored specifically for wry development patterns
 
+### Changed
+
+- **Documentation cross-references** 🔗
+  - README.md: Added Contributing section with links to CONTRIBUTING.md, .cursorrules, AI_KNOWLEDGE_BASE.md
+  - AI_KNOWLEDGE_BASE.md: Updated header with related documentation links
+  - AI_KNOWLEDGE_BASE.md: Updated version to 0.5.0+ and test count to 494
+  - AI_KNOWLEDGE_BASE.md: Added separate guidance sections for AI assistants and contributors
+  - Creates clear documentation hierarchy and navigation
+
+- **CHANGELOG requirements strengthened** ⚠️
+  - .cursorrules: Made CHANGELOG.md update mandatory and explicit (first item)
+  - CONTRIBUTING.md: Added prominent warning that CHANGELOG.md updates are required for every commit
+  - CONTRIBUTING.md: Listed all CHANGELOG sections (Added/Changed/Fixed/Deprecated/Removed/Security)
+  - RELEASE_PROCESS.md: Clarified [Unreleased] → versioned section workflow
+  - RELEASE_PROCESS.md: Documented that commits add to [Unreleased] during development
+  - RELEASE_PROCESS.md: Explained that release commit converts [Unreleased] to [X.Y.Z]
+
+- **TODO.md integration** 📋
+  - .cursorrules: Added TODO.md update as step 5 in pre-commit requirements
+  - CONTRIBUTING.md: Added TODO.md checklist item (mark completed, update progress)
+  - RELEASE_PROCESS.md: Check TODO.md before release, update after release
+  - README.md: Added comprehensive "Documentation Index" section
+  - README.md: Listed TODO.md in "For Contributors" section
+  - README.md: Added "Quick Start Navigation" for users/contributors/AI assistants
+
 ### Tests
 
 - **Additional comma-separated test** (494 total tests)

{wry-0.5.1.dev3 → wry-0.5.1.dev5}/CONTRIBUTING.md

@@ -434,9 +434,17 @@ def test_feature_with_clear_name():
 
 ### 1. Documentation Updates
 
+**⚠️ ALWAYS UPDATE CHANGELOG.md - This is required for every commit!**
+
+- [ ] **CHANGELOG.md**: **ALWAYS** add entry under `[Unreleased]` with appropriate section:
+  - `Added` - New features, new files, new capabilities
+  - `Changed` - Changes to existing functionality, documentation updates
+  - `Fixed` - Bug fixes
+  - `Deprecated` - Features that will be removed
+  - `Removed` - Removed features
+  - `Security` - Security fixes
 - [ ] **README.md**: Update if user-facing features, usage, or API changed
 - [ ] **AI_KNOWLEDGE_BASE.md**: Update if architecture, implementation details, or patterns changed
-- [ ] **CHANGELOG.md**: Add entry under `[Unreleased]` with section (Added/Changed/Fixed/Deprecated/Removed)
 - [ ] **Module docstrings**: Update docstrings in modified modules
 - [ ] **Examples**: Add or update examples if demonstrating new features
 
@@ -477,7 +485,15 @@ mypy wry/
 
 **Note**: Git commits automatically run pre-commit hooks (ruff, mypy, pytest). All must pass.
 
-### 5. wry-Specific Checks
+### 5. Update TODO.md (if applicable)
+
+- [ ] **TODO.md**: Update if working on tracked tasks
+  - Mark completed tasks as done (✅)
+  - Remove completed items or move to archive
+  - Update progress notes on ongoing work
+  - Add new tasks if discovered during development
+
+### 6. wry-Specific Checks
 
 - [ ] **Source tracking works**: If touching config/model code, verify source tracking
 - [ ] **Precedence correct**: CLI > JSON > ENV > DEFAULT (verify if changing)
@@ -624,10 +640,22 @@ If pre-commit hooks are failing:
 ❌ Make breaking changes without major version bump
 ❌ Ignore linter/type checker errors
 
+## Release Process
+
+For information about creating releases, see **`RELEASE_PROCESS.md`**.
+
+**Key points**:
+- During development: Add all changes to `[Unreleased]` in CHANGELOG.md
+- When releasing: Convert `[Unreleased]` to `[X.Y.Z] - YYYY-MM-DD`
+- Tag the release commit: `git tag -s vX.Y.Z`
+- See RELEASE_PROCESS.md for complete step-by-step instructions
+
 ## Questions?
 
 - Check `examples/` for usage patterns
 - Check `AI_KNOWLEDGE_BASE.md` for complete technical reference
 - Check `README.md` for user documentation
+- Check `RELEASE_PROCESS.md` for release workflow
+- Check `TODO.md` for current tasks and planned features
 - Check `tests/features/test_source_precedence.py` for source tracking examples
 - Open an issue for questions or clarifications

{wry-0.5.1.dev3/wry.egg-info → wry-0.5.1.dev5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wry
-Version: 0.5.1.dev3
+Version: 0.5.1.dev5
 Summary: Why Repeat Yourself? - Define your CLI once with Pydantic models
 Author-email: Tyler House <26489166+tahouse@users.noreply.github.com>
 License: MIT
@@ -892,7 +892,14 @@ The wry codebase is organized into focused modules:
 
 ## Contributing
 
-We welcome contributions! Please follow these guidelines to ensure a smooth process.
+We welcome contributions! Please see **`CONTRIBUTING.md`** for comprehensive guidelines.
+
+**Quick links**:
+
+- 📖 **`CONTRIBUTING.md`** - Complete contributor guide (for humans)
+- 🤖 **`.cursorrules`** - AI assistant quick reference
+- 📚 **`AI_KNOWLEDGE_BASE.md`** - Complete technical reference
+- 🚀 **`RELEASE_PROCESS.md`** - Release workflow and versioning
 
 ### Development Setup
 
@@ -1059,6 +1066,50 @@ mypy wry
 - Start a discussion for general questions
 - Check existing issues/PRs before creating new ones
 
+## Documentation Index
+
+wry has comprehensive documentation for different audiences:
+
+### For Users
+- 📘 **`README.md`** (this file) - Getting started, features, usage examples
+- 📁 **`examples/`** - Working code examples
+  - `examples/autowrymodel_comprehensive.py` - Complete AutoWryModel features
+  - `examples/wrymodel_comprehensive.py` - WryModel with source tracking
+  - `examples/multimodel_comprehensive.py` - Multi-model usage
+
+### For Contributors
+- 📖 **`CONTRIBUTING.md`** - Complete contributor guide with code patterns and checklists
+- 🤖 **`.cursorrules`** - AI assistant quick reference (references CONTRIBUTING.md)
+- 🚀 **`RELEASE_PROCESS.md`** - How to create releases and manage versions
+- 📋 **`TODO.md`** - Current tasks, planned features, and work in progress
+
+### Technical Reference
+- 📚 **`AI_KNOWLEDGE_BASE.md`** - Complete technical reference for AI/LLMs (also useful for humans)
+- 📝 **`CHANGELOG.md`** - Version history and all changes
+- 🧪 **`tests/README.md`** - Test organization and structure
+- 🔧 **`scripts/README.md`** - Development scripts and tools
+
+### Quick Start Navigation
+
+**I'm a user, I want to...**
+- Get started → README.md "Quick Start" section
+- See examples → `examples/` directory
+- Understand features → README.md "Features" section
+- Track config sources → README.md "Value Source Tracking" section
+
+**I'm a contributor, I want to...**
+- Set up development → CONTRIBUTING.md "Development Setup" section
+- Add a feature → CONTRIBUTING.md "Adding New Features" section
+- Run tests → CONTRIBUTING.md "Testing" section
+- Create a release → RELEASE_PROCESS.md
+- Check current tasks → TODO.md
+
+**I'm an AI assistant, I want to...**
+- Quick reference → `.cursorrules`
+- Technical details → `AI_KNOWLEDGE_BASE.md`
+- Code patterns → `CONTRIBUTING.md`
+- Test examples → `tests/features/test_source_precedence.py`
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

{wry-0.5.1.dev3 → wry-0.5.1.dev5}/README.md

@@ -848,7 +848,14 @@ The wry codebase is organized into focused modules:
 
 ## Contributing
 
-We welcome contributions! Please follow these guidelines to ensure a smooth process.
+We welcome contributions! Please see **`CONTRIBUTING.md`** for comprehensive guidelines.
+
+**Quick links**:
+
+- 📖 **`CONTRIBUTING.md`** - Complete contributor guide (for humans)
+- 🤖 **`.cursorrules`** - AI assistant quick reference
+- 📚 **`AI_KNOWLEDGE_BASE.md`** - Complete technical reference
+- 🚀 **`RELEASE_PROCESS.md`** - Release workflow and versioning
 
 ### Development Setup
 
@@ -1015,6 +1022,50 @@ mypy wry
 - Start a discussion for general questions
 - Check existing issues/PRs before creating new ones
 
+## Documentation Index
+
+wry has comprehensive documentation for different audiences:
+
+### For Users
+- 📘 **`README.md`** (this file) - Getting started, features, usage examples
+- 📁 **`examples/`** - Working code examples
+  - `examples/autowrymodel_comprehensive.py` - Complete AutoWryModel features
+  - `examples/wrymodel_comprehensive.py` - WryModel with source tracking
+  - `examples/multimodel_comprehensive.py` - Multi-model usage
+
+### For Contributors
+- 📖 **`CONTRIBUTING.md`** - Complete contributor guide with code patterns and checklists
+- 🤖 **`.cursorrules`** - AI assistant quick reference (references CONTRIBUTING.md)
+- 🚀 **`RELEASE_PROCESS.md`** - How to create releases and manage versions
+- 📋 **`TODO.md`** - Current tasks, planned features, and work in progress
+
+### Technical Reference
+- 📚 **`AI_KNOWLEDGE_BASE.md`** - Complete technical reference for AI/LLMs (also useful for humans)
+- 📝 **`CHANGELOG.md`** - Version history and all changes
+- 🧪 **`tests/README.md`** - Test organization and structure
+- 🔧 **`scripts/README.md`** - Development scripts and tools
+
+### Quick Start Navigation
+
+**I'm a user, I want to...**
+- Get started → README.md "Quick Start" section
+- See examples → `examples/` directory
+- Understand features → README.md "Features" section
+- Track config sources → README.md "Value Source Tracking" section
+
+**I'm a contributor, I want to...**
+- Set up development → CONTRIBUTING.md "Development Setup" section
+- Add a feature → CONTRIBUTING.md "Adding New Features" section
+- Run tests → CONTRIBUTING.md "Testing" section
+- Create a release → RELEASE_PROCESS.md
+- Check current tasks → TODO.md
+
+**I'm an AI assistant, I want to...**
+- Quick reference → `.cursorrules`
+- Technical details → `AI_KNOWLEDGE_BASE.md`
+- Code patterns → `CONTRIBUTING.md`
+- Test examples → `tests/features/test_source_precedence.py`
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

wry-0.5.1.dev5/RELEASE_PROCESS.md

@@ -0,0 +1,120 @@
+# Release Process for Wry
+
+This document outlines the correct process for creating a new release.
+
+## Development Workflow
+
+### During Development (Between Releases)
+
+As you make commits, **ALWAYS update CHANGELOG.md** under `[Unreleased]`:
+
+```markdown
+## [Unreleased]
+
+### Added
+- New feature X
+
+### Fixed
+- Bug Y
+```
+
+**Every commit** should add its changes to the `[Unreleased]` section. This keeps the changelog up-to-date continuously.
+
+### When Ready to Release
+
+Follow these steps IN ORDER:
+
+1. **Verify all changes are in [Unreleased]**
+   - Check that CHANGELOG.md `[Unreleased]` section has all changes since last release
+   - Check TODO.md - all planned release items should be completed
+   - Ensure all tests pass (`pytest`)
+   - Fix any linting issues
+
+2. **Update CHANGELOG.md for release**
+   - Change `## [Unreleased]` to `## [X.Y.Z] - YYYY-MM-DD`
+   - Add a new empty `## [Unreleased]` section above it
+   - Update comparison links at bottom if present
+
+   **Example**:
+   ```markdown
+   ## [Unreleased]
+
+   ## [0.5.0] - 2025-10-14
+
+   ### Added
+   - Feature from unreleased section (now part of 0.5.0)
+   ```
+
+3. **Update documentation**
+   - Update README.md if needed
+   - Update AI_KNOWLEDGE_BASE.md version numbers
+   - Update any affected documentation
+
+4. **Commit the release preparation**
+   ```bash
+   git add -A
+   git commit -m "chore: prepare for vX.Y.Z release"
+   ```
+
+5. **Create signed tag on the release commit**
+   ```bash
+   git tag -s vX.Y.Z -m "Release vX.Y.Z: brief description"
+   ```
+
+6. **Push changes and tag**
+   ```bash
+   git push origin main
+   git push origin vX.Y.Z
+   ```
+
+### After the Release
+
+Continue development by:
+1. Adding new changes to the (now empty) `[Unreleased]` section in CHANGELOG.md
+2. Updating TODO.md:
+   - Archive or remove completed items from the released version
+   - Add new tasks or features planned for next release
+   - Update roadmap and priorities
+3. Update version numbers in AI_KNOWLEDGE_BASE.md if not already done
+
+## Example
+
+For v0.1.8 release:
+
+```bash
+# 1. Make code changes
+# ... implement type annotation improvements ...
+
+# 2. Update CHANGELOG.md
+# Add new section:
+## [0.1.8] - 2025-09-10
+
+### Fixed
+- Improved type annotations for `generate_click_parameters` decorator
+
+# 3. Commit everything
+git add -A
+git commit -m "chore: prepare for v0.1.8 release"
+
+# 4. Create tag
+git tag -s v0.1.8 -m "Release v0.1.8: improve type annotations"
+
+# 5. Push
+git push origin main
+git push origin v0.1.8
+```
+
+## Common Mistakes to Avoid
+
+- ❌ Creating the tag before updating CHANGELOG.md
+- ❌ Forgetting to update comparison links in CHANGELOG.md
+- ❌ Not running `./check.sh` before tagging
+- ❌ Creating unsigned tags (always use `-s` for signed tags)
+
+## CI/CD Pipeline
+
+Once a tag is pushed, the GitHub Actions workflow will:
+1. Run all tests across Python 3.10, 3.11, and 3.12
+2. Build the distribution packages
+3. Publish to PyPI (for tags) or TestPyPI (for main branch)
+4. Create a GitHub release with notes from CHANGELOG.md

{wry-0.5.1.dev3 → wry-0.5.1.dev5}/wry/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.5.1.dev3'
-__version_tuple__ = version_tuple = (0, 5, 1, 'dev3')
+__version__ = version = '0.5.1.dev5'
+__version_tuple__ = version_tuple = (0, 5, 1, 'dev5')
 
-__commit_id__ = commit_id = 'ga2ad84576'
+__commit_id__ = commit_id = 'g1a3d554bc'

{wry-0.5.1.dev3 → wry-0.5.1.dev5/wry.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wry
-Version: 0.5.1.dev3
+Version: 0.5.1.dev5
 Summary: Why Repeat Yourself? - Define your CLI once with Pydantic models
 Author-email: Tyler House <26489166+tahouse@users.noreply.github.com>
 License: MIT
@@ -892,7 +892,14 @@ The wry codebase is organized into focused modules:
 
 ## Contributing
 
-We welcome contributions! Please follow these guidelines to ensure a smooth process.
+We welcome contributions! Please see **`CONTRIBUTING.md`** for comprehensive guidelines.
+
+**Quick links**:
+
+- 📖 **`CONTRIBUTING.md`** - Complete contributor guide (for humans)
+- 🤖 **`.cursorrules`** - AI assistant quick reference
+- 📚 **`AI_KNOWLEDGE_BASE.md`** - Complete technical reference
+- 🚀 **`RELEASE_PROCESS.md`** - Release workflow and versioning
 
 ### Development Setup
 
@@ -1059,6 +1066,50 @@ mypy wry
 - Start a discussion for general questions
 - Check existing issues/PRs before creating new ones
 
+## Documentation Index
+
+wry has comprehensive documentation for different audiences:
+
+### For Users
+- 📘 **`README.md`** (this file) - Getting started, features, usage examples
+- 📁 **`examples/`** - Working code examples
+  - `examples/autowrymodel_comprehensive.py` - Complete AutoWryModel features
+  - `examples/wrymodel_comprehensive.py` - WryModel with source tracking
+  - `examples/multimodel_comprehensive.py` - Multi-model usage
+
+### For Contributors
+- 📖 **`CONTRIBUTING.md`** - Complete contributor guide with code patterns and checklists
+- 🤖 **`.cursorrules`** - AI assistant quick reference (references CONTRIBUTING.md)
+- 🚀 **`RELEASE_PROCESS.md`** - How to create releases and manage versions
+- 📋 **`TODO.md`** - Current tasks, planned features, and work in progress
+
+### Technical Reference
+- 📚 **`AI_KNOWLEDGE_BASE.md`** - Complete technical reference for AI/LLMs (also useful for humans)
+- 📝 **`CHANGELOG.md`** - Version history and all changes
+- 🧪 **`tests/README.md`** - Test organization and structure
+- 🔧 **`scripts/README.md`** - Development scripts and tools
+
+### Quick Start Navigation
+
+**I'm a user, I want to...**
+- Get started → README.md "Quick Start" section
+- See examples → `examples/` directory
+- Understand features → README.md "Features" section
+- Track config sources → README.md "Value Source Tracking" section
+
+**I'm a contributor, I want to...**
+- Set up development → CONTRIBUTING.md "Development Setup" section
+- Add a feature → CONTRIBUTING.md "Adding New Features" section
+- Run tests → CONTRIBUTING.md "Testing" section
+- Create a release → RELEASE_PROCESS.md
+- Check current tasks → TODO.md
+
+**I'm an AI assistant, I want to...**
+- Quick reference → `.cursorrules`
+- Technical details → `AI_KNOWLEDGE_BASE.md`
+- Code patterns → `CONTRIBUTING.md`
+- Test examples → `tests/features/test_source_precedence.py`
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

wry-0.5.1.dev3/RELEASE_PROCESS.md

@@ -1,80 +0,0 @@
-# Release Process for Wry
-
-This document outlines the correct process for creating a new release.
-
-## Release Checklist
-
-Follow these steps IN ORDER for each release:
-
-1. **Make all code changes**
-   - Implement features/fixes
-   - Ensure all tests pass (`./check.sh`)
-   - Fix any linting issues
-
-2. **Update documentation**
-   - Update README.md if needed
-   - Update any affected documentation
-
-3. **Update CHANGELOG.md**
-   - Add a new version section under `## [Unreleased]`
-   - Document all changes following [Keep a Changelog](https://keepachangelog.com/) format
-   - Update the comparison links at the bottom of the file
-
-4. **Commit all changes**
-   ```bash
-   git add -A
-   git commit -m "chore: prepare for vX.Y.Z release"
-   ```
-
-5. **Create signed tag**
-   ```bash
-   git tag -s vX.Y.Z -m "Release vX.Y.Z: brief description"
-   ```
-
-6. **Push changes and tag**
-   ```bash
-   git push origin main
-   git push origin vX.Y.Z
-   ```
-
-## Example
-
-For v0.1.8 release:
-
-```bash
-# 1. Make code changes
-# ... implement type annotation improvements ...
-
-# 2. Update CHANGELOG.md
-# Add new section:
-## [0.1.8] - 2025-09-10
-
-### Fixed
-- Improved type annotations for `generate_click_parameters` decorator
-
-# 3. Commit everything
-git add -A
-git commit -m "chore: prepare for v0.1.8 release"
-
-# 4. Create tag
-git tag -s v0.1.8 -m "Release v0.1.8: improve type annotations"
-
-# 5. Push
-git push origin main
-git push origin v0.1.8
-```
-
-## Common Mistakes to Avoid
-
-- ❌ Creating the tag before updating CHANGELOG.md
-- ❌ Forgetting to update comparison links in CHANGELOG.md
-- ❌ Not running `./check.sh` before tagging
-- ❌ Creating unsigned tags (always use `-s` for signed tags)
-
-## CI/CD Pipeline
-
-Once a tag is pushed, the GitHub Actions workflow will:
-1. Run all tests across Python 3.10, 3.11, and 3.12
-2. Build the distribution packages
-3. Publish to PyPI (for tags) or TestPyPI (for main branch)
-4. Create a GitHub release with notes from CHANGELOG.md