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.

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

Human-readable release notes? #3960

Open
asmaloney opened this issue Jan 3, 2024 · 1 comment
Open

Human-readable release notes? #3960

asmaloney opened this issue Jan 3, 2024 · 1 comment
Assignees

Comments

@asmaloney
Copy link

Description

Would it be possible to get human-readable release notes on the releases rather than a dump of the commit log?

Why Buefy need this feature

It's hard to wade through all the changes to figure out what's important for the end user given one-line of a commit log.

Essentially we have to go read every single issue/PR to see if it's important or not.

I would suggest a format like this one

I see the CHANGELOG file, but it doesn't seem up-to-date and doesn't link (in an HTML, not a conceptual sense) to the PRs/issues.

Thank You

Thanks for continuing to improve Buefy!

@wesdevpro
Copy link
Member

Thank you for your feedback and linking keepachangelog.com @asmaloney!

Guiding Principles

Changelogs are for humans, not machines.
There should be an entry for every single version.
The same types of changes should be grouped.
Versions and sections should be linkable.
The latest version comes first.
The release date of each version is displayed.
Mention whether you follow Semantic Versioning.

Please give me some time to discuss with @kikuomax about your suggestions and we will get back to you 😎

@wesdevpro wesdevpro self-assigned this Jan 4, 2024
kikuomax added a commit to kikuomax/buefy that referenced this issue Jan 11, 2024
- `CHANGELOG.md` now has working links to relevant issues.

  I replaced the issue numbers in `CHANGELOG.md` with the Python script
  available from the following repo:
  https://github.com/kikuomax/link-commit-hash

issue buefy#3960
@wesdevpro wesdevpro pinned this issue Jan 11, 2024
kikuomax added a commit that referenced this issue Jan 11, 2024
* docs: update CHANGELOG.md

- Prepends changes from v0.9.27 to v0.9.28.
  Tells v0.9.26 was withdrawn due to missing `dist` folder in the
  package.

* docs: link CHANGELOG to relevant issues

- `CHANGELOG.md` now has working links to relevant issues.

  I replaced the issue numbers in `CHANGELOG.md` with the Python script
  available from the following repo:
  https://github.com/kikuomax/link-commit-hash

issue #3960
kikuomax added a commit that referenced this issue Feb 9, 2024
* docs: update CHANGELOG.md

- Prepends changes from v0.9.27 to v0.9.28.
  Tells v0.9.26 was withdrawn due to missing `dist` folder in the
  package.

* docs: link CHANGELOG to relevant issues

- `CHANGELOG.md` now has working links to relevant issues.

  I replaced the issue numbers in `CHANGELOG.md` with the Python script
  available from the following repo:
  https://github.com/kikuomax/link-commit-hash

issue #3960
kikuomax added a commit to kikuomax/buefy that referenced this issue Feb 11, 2024
* docs: update CHANGELOG.md

- Prepends changes from v0.9.27 to v0.9.28.
  Tells v0.9.26 was withdrawn due to missing `dist` folder in the
  package.

* docs: link CHANGELOG to relevant issues

- `CHANGELOG.md` now has working links to relevant issues.

  I replaced the issue numbers in `CHANGELOG.md` with the Python script
  available from the following repo:
  https://github.com/kikuomax/link-commit-hash

issue buefy#3960
kikuomax added a commit to ntohq/buefy-next that referenced this issue Feb 12, 2024
* docs: update CHANGELOG.md

- Prepends changes from v0.9.27 to v0.9.28.
  Tells v0.9.26 was withdrawn due to missing `dist` folder in the
  package.

* docs: link CHANGELOG to relevant issues

- `CHANGELOG.md` now has working links to relevant issues.

  I replaced the issue numbers in `CHANGELOG.md` with the Python script
  available from the following repo:
  https://github.com/kikuomax/link-commit-hash

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

No branches or pull requests

3 participants