Conversation
per1234
left a comment
There was a problem hiding this comment.
Is the responsibility for maintaining the file on the contributor (i.e., changelog entry must be included in the PR), or on the project maintainer/release manager (i.e., they must write the changelog at some point(s) prior to the release)?
If the former, it should be documented in the pull request guide:
If the latter, it should be documented in a release procedure document.
Even if the responsibility is on the contributor, the release manager will still need to change the heading from [Unreleased] as part of the release procedure, so a step is required in the release procedure document regardless.
I recommend hosting the release procedure document in this repository. The release procedure document of the Arduino IDE repository can serve as a reference:
https://github.com/arduino/arduino-ide/blob/main/docs/internal/release-procedure.md
Co-authored-by: mirkoCrobu <214636120+mirkoCrobu@users.noreply.github.com>
Co-authored-by: Cristian Maglie <c.maglie@arduino.cc>
Correct formatting and capitalization in CHANGELOG entries.
Updated CHANGELOG to reflect recent removals and fixes.
Correct formatting and update changelog entries for various API changes, deprecations, and removals.
Removed redundant mention of `skip-python` from the HTTP `POST /v1/apps` request endpoint in the changelog.
Updated CHANGELOG with new features, deprecations, and fixes.
Added support for hidden field in brick index and new monitor command, removed old monitor command.
Motivation
Add a changelog.md file to keep track of the changes with a human-friendly explanation.
Change description
Additional Notes
Reviewer checklist
main.