bevyengine / bevyengine/bevy-website

Filter out small documentation improvements in changelogs

Open
#1,091 1 comment 0 reactions 0 assignees View on GitHub
A-Release-Notes S-Ready-For-Implementation
Dominant language
JavaScript
Stars
249
Forks
450
Avg merge
16h 20m
Merged PRs (30d)
6

Description

> 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](https://discord.com/channels/691052431525675048/692572690833473578/1216700801502810152)

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
- Suggested on [Discord](https://discord.com/channels/691052431525675048/692572690833473578/1216701657350406215)
- Potentially link to the Github diff, such as [`0.12.0...0.13.0`](https://github.com/bevyengine/bevy/compare/release-0.12.0...release-0.13.0), for a _full_ full changelog

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.