Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Improve documentation of new features in Changelog #1353

Open
scpeters opened this issue Jan 2, 2024 · 1 comment
Open

Improve documentation of new features in Changelog #1353

scpeters opened this issue Jan 2, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@scpeters
Copy link
Member

scpeters commented Jan 2, 2024

Desired behavior

Our Changelog currently has a list of pull requests included in each release with the pull request title, but it would be helpful to include more information about significant features included in each release. This could be included in the Changelog file itself and/or in the GitHub release page.

Alternatives considered

Implementation suggestion

Additional context
@scpeters scpeters added the enhancement New feature or request label Jan 2, 2024
@scpeters scpeters changed the title Improve documentation of new feature in Changelog Improve documentation of new features in Changelog Jan 2, 2024
@scpeters scpeters mentioned this issue Jan 2, 2024
Open
@azeey
Copy link
Collaborator

azeey commented Jan 18, 2024 •
edited
Loading

One option would be to adopt Conventional Commits. We can then use tools like https://git-cliff.org/ to generate more structured changelogs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
Core development
Status: To do
Milestone
No milestone
Development

No branches or pull requests
2 participants
@azeey @scpeters