Skip to content

CHANGELOG protocol #243

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

Open
ala-mode opened this issue Mar 14, 2025 · 0 comments
Open

CHANGELOG protocol #243

ala-mode opened this issue Mar 14, 2025 · 0 comments
Assignees

Comments

@ala-mode
Copy link
Contributor

We should have an agreed upon way to produce a changelog for releases.

Personally, I like the idea of leveraging GitHub Issues, which can generate changelogs based on closed PRs. This way, a well named PR (when it is closed-as-completed) can simply be included in the changelog.

One thing I have my eye on is release-drafter - a GitHub Action that automatically drafts release notes based on commits and pull requests. It can be configured to include specific labels, milestones, and other metadata, which could be useful in tracking work in relation to organizational goals.

When we agree on the method, I can include it in the CONTRIBUTING.md file.

Please enter your opinion in a comment here, or give me a simple thumbs up!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants