-
Notifications
You must be signed in to change notification settings - Fork 5
Add changelog.md #97
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Add changelog.md #97
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should also include this in the .deb package.
That should be installed in /usr/share/doc/arduino-app-cli/CHANGELOG.md.gz, better if gzipped
I would also move this to the root of the folder
per1234
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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>
Motivation
Add a changelog.md file to keep track of the changes with a human-friendly explanation.
Change description
Additional Notes
Reviewer checklist
main.