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

Filter out small documentation improvements in changelogs #1091

Open
BD103 opened this issue Mar 11, 2024 · 1 comment
Open

Filter out small documentation improvements in changelogs #1091

BD103 opened this issue Mar 11, 2024 · 1 comment
Labels
A-Release-Notes S-Ready-For-Implementation The core questions are answered: just add code

Comments

@BD103
Copy link
Member

BD103 commented Mar 11, 2024

it's kinda annoying that the bevy changelog includes all the tiny docs PRs

i want to know what changed in the ECS, but much of the A-ECS changelog is stuff like "clarify the purpose of commands in docs" (which changes 1 word), "fix typo in comment", ...

From @inodentry on Discord

Here are a few ideas:

  • Label PRs with something like Changelog-Irrelevant and filter them out in generate-release
    • They can either be removed entirely, or added to their own section.
  • Remove these small changes retroactively, after the initial changelog has been released
  • Potentially link to the Github diff, such as 0.12.0...0.13.0, for a full full changelog
@rparrett
Copy link
Contributor

The changelog is currently broken into sections by A-(Area) labels.

I would propose treating PRs labeled with C-Docs as a separate Docs section. This is doable without marking PRs as "irrelevant" or leaving any contributions out of the changelog.

@alice-i-cecile alice-i-cecile added S-Ready-For-Final-Review Ready for a maintainer to consider for merging S-Ready-For-Implementation The core questions are answered: just add code A-Release-Notes and removed S-Ready-For-Final-Review Ready for a maintainer to consider for merging C-Content labels May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Release-Notes S-Ready-For-Implementation The core questions are answered: just add code
Projects
None yet
Development

No branches or pull requests

3 participants