diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 99837c6..45716b9 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -134,6 +134,10 @@ GitHub Copilot will automatically validate if new test cases should be created o ### Pull Request Guidelines - **ALWAYS update CHANGELOG.md** - Every PR that introduces new functionality, fixes issues, or makes changes must include a detailed changelog entry with issue references (e.g., "Fixes #16") + - Add entries under `## **WORK IN PROGRESS**` section following AlCalzone release-script standard + - Use format: `- (author) **TYPE**: Description of user-visible change (Fixes #XX)` + - Types: **NEW** (features), **FIXED** (bugs), **ENHANCED** (improvements), **TESTING** (test additions), **CI/CD** (automation) + - Focus on user impact, not technical implementation details - **ALWAYS update README.md** - When adding new functionality, infrastructure, or changing how users interact with the repository, update the relevant sections of README.md - PRs must update version numbers appropriately using the dynamic version management system - Include detailed CHANGELOG.md entries for user-facing changes with specific details about what was added/changed/fixed diff --git a/CHANGELOG.md b/CHANGELOG.md index d27e4e3..bfac0e5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,15 @@ All notable changes to the ioBroker Copilot Instructions template will be docume 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). + + +## **WORK IN PROGRESS** + +- (copilot) **ENHANCED**: Standardized changelog format inconsistencies to align with AlCalzone release-script standard - fixed mixed WORK IN PROGRESS formatting and added comprehensive changelog management documentation (Fixes #20) + ## [0.4.0] - 2025-09-XX - Automated Version handling & validation by GitHub actions ### Added @@ -35,6 +44,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - **Eliminated Static Version References** - All version numbers and dates are now dynamically generated from template source - **Cross-Documentation Consistency** - Automated validation ensures all files reference the same version - **Date Management** - Automatic current date insertion eliminates stale date references (e.g., "January 2025" → current month/year) +- **AlCalzone Release-Script Changelog Compliance** - Standardized all WORK IN PROGRESS references to use correct `## **WORK IN PROGRESS**` format and added comprehensive changelog management guidance (Fixes #20) - **Automated Testing Requirements** - Updated Copilot instructions with mandatory testing guidelines for new functionality - **Quality Assurance Through Testing** - Comprehensive test coverage prevents regressions and ensures script reliability - **CI/CD Integration** - Automated testing on all repository changes maintains code quality diff --git a/template.md b/template.md index 271ec7f..7187307 100644 --- a/template.md +++ b/template.md @@ -367,7 +367,7 @@ When updating README.md files, ensure these sections are present and well-docume 1. **Installation** - Clear npm/ioBroker admin installation steps 2. **Configuration** - Detailed configuration options with examples 3. **Usage** - Practical examples and use cases -4. **Changelog** - Version history and changes (use "## **WORK IN PROGRESS**" section for ongoing changes) +4. **Changelog** - Version history and changes (use "## **WORK IN PROGRESS**" section for ongoing changes following AlCalzone release-script standard) 5. **License** - License information (typically MIT for ioBroker adapters) 6. **Support** - Links to issues, discussions, and community support @@ -382,7 +382,7 @@ When updating README.md files, ensure these sections are present and well-docume ### Mandatory README Updates for PRs For **every PR or new feature**, always add a user-friendly entry to README.md: -- Add entries under `### __WORK IN PROGRESS__` section before committing +- Add entries under `## **WORK IN PROGRESS**` section before committing - Use format: `* (author) **TYPE**: Description of user-visible change` - Types: **NEW** (features), **FIXED** (bugs), **ENHANCED** (improvements), **TESTING** (test additions), **CI/CD** (automation) - Focus on user impact, not technical implementation details @@ -393,6 +393,53 @@ For **every PR or new feature**, always add a user-friendly entry to README.md: - **Standardized documentation**: Create consistent format and categories for changelog entries - **Enhanced development workflow**: Integrate documentation requirements into standard development process +### Changelog Management with AlCalzone Release-Script +Follow the [AlCalzone release-script](https://github.com/AlCalzone/release-script) standard for changelog management: + +#### Format Requirements +- Always use `## **WORK IN PROGRESS**` as the placeholder for new changes +- Add all PR/commit changes under this section until ready for release +- Never modify version numbers manually - only when merging to main branch +- Maintain this format in README.md or CHANGELOG.md: + +```markdown +# Changelog + + + +## **WORK IN PROGRESS** + +- Did some changes +- Did some more changes + +## v0.1.0 (2023-01-01) +Initial release +``` + +#### Workflow Process +- **During Development**: All changes go under `## **WORK IN PROGRESS**` +- **For Every PR**: Add user-facing changes to the WORK IN PROGRESS section +- **Before Merge**: Version number and date are only added when merging to main +- **Release Process**: The release-script automatically converts the placeholder to the actual version + +#### Change Entry Format +Use this consistent format for changelog entries: +- `- (author) **TYPE**: User-friendly description of the change` +- Types: **NEW** (features), **FIXED** (bugs), **ENHANCED** (improvements) +- Focus on user impact, not technical implementation details +- Reference related issues: "fixes #XX" or "solves #XX" + +#### Example Entry +```markdown +## **WORK IN PROGRESS** + +- (DutchmanNL) **FIXED**: Adapter now properly validates login credentials instead of always showing "credentials missing" (fixes #25) +- (DutchmanNL) **NEW**: Added support for device discovery to simplify initial setup +``` + ## Dependency Updates ### Package Management