Improve the CHANGELOG #787
Description
Is your feature request related to a problem? Please describe.
As of now we generate the release notes by either manually maintaining a local list of changes or by pulling the updates from CHANGELOGs in different repos. However, there is gap between what users want to get from release notes and what's documented now in the CHANGELOGs. Therefore, a proposal is made for different squads to unify the CHANGELOG formats if you have it set up. This will also help the doc squad to automate the generation of release notes from CHANGELOGs.
Describe the solution you'd like
- What changes are required in existing CHANGELOGs？
- Include an issue or PR number for each entry if applicable. This helps users learn more about the change when needed.
- Indicate whether the change is a new feature/enhancement or a bug fix. This helps users understand quickly what new enhancements are introduced and decide whether to upgrade.
You can create separate sections for “New features and enhancements” and “Bug fixes” in the CHANGELOG and add updates into the correct section. Alternatively, use labels (feature, bugfix) to entries to help understand the type.
-
Are there anything else that needs to be done?
We recommend that some writing style tips be provided to help write better CHANGELOGs. See our proposal doc for specifics.
Ensure that the writer from the squad review the CHANGELOG before a release is published.
Additional context
https://github.com/zowe/api-layer/blob/master/CHANGELOG.md