Fix changelog format inconsistencies and implement consistent changelog management for repository#21
Conversation
…script standard Co-authored-by: DutchmanNL <7318445+DutchmanNL@users.noreply.github.com>
|
@copilot also ensure those instructions are used for this repository to manage entries in changelog accordingly... also for this pr. :/ add an entry (if not exit) work in progress according to the template in changelog en summarize the pr changes. |
…ructions for consistent changelog management Co-authored-by: DutchmanNL <7318445+DutchmanNL@users.noreply.github.com>
Added WORK IN PROGRESS section to CHANGELOG.md following the AlCalzone release-script standard and enhanced the repository's copilot instructions to ensure every PR maintains consistent changelog entries. The entry for this PR has been added under the WORK IN PROGRESS section. Commit 7f8a2c1. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
There was a problem hiding this comment.
Pull Request Overview
This PR addresses changelog format inconsistencies in the ioBroker template by standardizing the WORK IN PROGRESS section format and implementing comprehensive changelog management guidelines aligned with the AlCalzone release-script standard.
- Fixed inconsistent WORK IN PROGRESS formatting from mixed
##and###headers to consistent## **WORK IN PROGRESS** - Added comprehensive changelog management section with format requirements, workflow process, and examples
- Applied the same standards to the repository's own CHANGELOG.md with proper WORK IN PROGRESS section
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| template.md | Fixed WORK IN PROGRESS format inconsistency and added comprehensive AlCalzone release-script changelog management section |
| CHANGELOG.md | Added WORK IN PROGRESS section and documented this PR's changes following the established standard |
| .github/copilot-instructions.md | Enhanced PR guidelines with specific changelog format requirements and entry standards |
The template had inconsistent formatting for changelog WORK IN PROGRESS sections, mixing
## **WORK IN PROGRESS**(correct) with### __WORK IN PROGRESS__(incorrect). This created confusion for ioBroker adapter developers about the proper changelog format.Changes Made
Format Standardization
### __WORK IN PROGRESS__to## **WORK IN PROGRESS**Comprehensive Documentation
Added a new "Changelog Management with AlCalzone Release-Script" section that provides:
## **WORK IN PROGRESS**placeholder with example code blocksRepository Changelog Management
## **WORK IN PROGRESS**section to this repository's CHANGELOG.md following the same AlCalzone release-script standard.github/copilot-instructions.mdwith detailed guidelines for maintaining CHANGELOG.md to ensure every future PR follows consistent changelog formatExample Before/After
Before (inconsistent):
After (standardized):
The template now provides clear, authoritative guidance following the AlCalzone release-script standard where all development changes go under
## **WORK IN PROGRESS**and version numbers are only added when merging to main branch. This repository now follows its own guidelines with proper changelog management infrastructure.Validation
Fixes #20.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.