create-ai-context/CHANGELOG.md

🤖 Generate AI-optimized project documentation and context files for better AI-assisted development. Creates structured templates with version control, architectural documentation, and clear guidelines for AI tools like Claude Code, GitHub Copilot, and Ch

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added
- **Path Validation** - Comprehensive directory path validation with user-friendly error handling:
  - Direct mode validates parent directory exists before proceeding
  - Interactive mode offers options to create directory, retry with different path, or exit
  - Clear error messages guide users to valid paths
- **Core Documentation File Checking** - Smart handling of existing documentation files:
  - Detects existing ARCHITECTURE.md, DEVELOPMENT_PLAN.md, and README.md files
  - Provides clear user options: overwrite all, leave as-is, choose individually, or exit
  - Enhanced force mode messaging for core documentation overwrites
- **Enhanced Test Coverage** - Added comprehensive test scenarios:
  - Path validation testing for both valid and invalid parent directories
  - Core documentation file overwrite testing with force mode
  - Total test count increased to 15 tests with 100% pass rate

## [0.2.0] - 2025-09-20

### BREAKING CHANGES
- **Template Structure Simplified**: Reduced from 6 files to 3 core files
- **File Location Changed**: All files now created in project root (no more `docs/` directory)
- **Removed Templates**: `PROJECT_RULES.md`, `README.md`, and `DEVELOPER_GUIDE.md` no longer generated

### Added
- README.md detection and guidance - AI agents now receive instructions to check for existing README.md and either update or create comprehensive project documentation
- Force flag (--force/-f) for CLI to overwrite existing files without prompting
- README.md status indicator in ai-instructions.md template
- **Git Worktree Parallel Workflows** - Added comprehensive parallel development strategy support:
  - Phase dependency assessment in DEVELOPMENT_PLAN.md template
  - AI-guided analysis for identifying parallel workflow opportunities (Step 4 in ai-instructions.md)
  - Parallel development strategy section with worktree setup and commands
  - Comprehensive GitHub Pages documentation at `/worktree-workflows`
  - Integration with AI permission system for plan updates
- **Streamlined Interactive Mode** - Simplified user experience to only essential questions:
  - Removed project configuration prompts (name, description, tech stack, architecture, language)
  - Now only asks for directory and AI agent selection + file overwrite handling
  - AI agents handle all project analysis and configuration automatically
  - Faster setup with smart defaults
- **Agent Name Normalization** - Intelligent handling of agent name variations and misspellings:
  - Supports common variations: `claude`, `claude-code`, `cursor`, `codex`, `other`
  - Handles misspellings: `curser` → `cursor`, `claud` → `claude`
  - Maps aliases: `chatgpt`, `gpt`, `copilot` → `codex`
  - Graceful fallback to `other` for unrecognized names with helpful message
  - Updated help text and error messages to show all supported variations
- GitHub workflow for automated NPM publishing on tag creation
- Comprehensive test suite with 15 test cases
- ESLint configuration for code quality
- Development commands for testing CLI functionality
- Cleanup guidance for ai-instructions.md file
- Enhanced content consolidation from removed templates

### Changed
- **SIMPLIFIED STRUCTURE**: Now creates only 3 essential files:
  - `DEVELOPMENT_PLAN.md` (root) - Project roadmap + development guidelines
  - `ARCHITECTURE.md` (root) - Technical architecture + code standards
  - `ai-instructions.md` (root) - AI agent setup instructions
- Merged development guidelines from PROJECT_RULES.md into DEVELOPMENT_PLAN.md
- Merged code standards and security guidelines into ARCHITECTURE.md
- Updated ai-instructions.md to remove docs/ folder references
- Reorganized GitHub Pages documentation with quickstart-first approach
- Updated CLAUDE.md to be more concise and focused
- Enhanced package.json with organized script categories

### Fixed
- Template placeholder consistency across all files
- CLI argument validation for both interactive and direct modes

### Migration Guide
Users upgrading from v1.x should note:
- Old: 6 files (4 root + 2 in docs/)
- New: 3 files (all in root)
- Essential functionality preserved, complexity reduced
- Manual migration not required - just re-run the CLI

## [0.1.0] - 2025-09-20

### Added
- Initial release of create-ai-context CLI tool
- Two-flow CLI design (Interactive and Direct modes)
- Smart project detection (new, empty, minimal, existing)
- Multi-agent support (Claude Code, Cursor, Codex)
- Seven template files with AI-optimized documentation
- Version tracking for strategic documents
- AI-guided template population system
- Comprehensive documentation and contributor guides

### Features
- `AI_CONTEXT.md` - Essential context for AI assistants
- `DEVELOPMENT_PLAN.md` - Project roadmap with version tracking
- `PROJECT_RULES.md` - Development constraints and guidelines
- `README.md` - Project documentation
- `ai-instructions.md` - Step-by-step AI guidance
- `docs/ARCHITECTURE.md` - Technical architecture documentation
- `docs/DEVELOPER_GUIDE.md` - Human developer workflows

### CLI Options
- Interactive mode: `npx create-ai-context`
- Direct mode: `npx create-ai-context --agent <name> --path <directory>`
- Smart project detection and template customization
- Safe overwrite protection with user confirmation

[Unreleased]: https://github.com/bishnubista/create-ai-context/compare/v0.2.0...HEAD
[0.2.0]: https://github.com/bishnubista/create-ai-context/compare/v0.1.0...v0.2.0
[0.1.0]: https://github.com/bishnubista/create-ai-context/releases/tag/v0.1.0