Critical Patterns
Structure (REQUIRED)
Changelog
All notable changes will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
[Unreleased]
Added
- New features
Changed
- Changes to existing functionality
Fixed
- Bug fixes
[1.2.0] - 2024-01-15
Added
- Multi-language support (#123)
Change Types (REQUIRED)
Added → New features, endpoints, options Changed → Changes to existing functionality Deprecated → Features planned for removal Removed → Deleted features Fixed → Bug fixes Security → Vulnerability patches
Decision Tree
New feature? → Added Behavior change? → Changed Bug fix? → Fixed Security patch? → Security Will be removed? → Deprecated Already removed? → Removed
Code Examples
Good Entry
Added
- Email notifications for order status changes with customizable templates
- Batch processing support for up to 1000 items per request
Fixed
- Race condition in payment processing that could cause duplicate charges
- Memory leak when uploading files larger than 100MB
Bad Entry
Added
- New feature (too vague)
- Updated stuff (unclear)
Fixed
- Fixed bug (which bug?)
Best Practices
-
Update changelog with every PR
-
Write from the user's perspective
-
Include issue/PR numbers for reference
-
Date entries in ISO format (YYYY-MM-DD)
-
Keep unreleased changes at the top