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

[docs] CHANGELOG: keepachangelog format #1912

Open
ianlewis opened this issue Apr 3, 2023 · 0 comments
Open

[docs] CHANGELOG: keepachangelog format #1912

ianlewis opened this issue Apr 3, 2023 · 0 comments
Labels
type:documentation Improvements or additions to documentation

Comments

@ianlewis
Copy link
Member

ianlewis commented Apr 3, 2023

Update CHANGELOG.md to be based off of https://keepachangelog.com/en/1.1.0/

We will need slight modifications so that we can logically group updates by builder but we can use the Added, Changed, etc. labels that are noted here.

Heading titles should also be formatted to avoid duplication (this will make it so the rendered html ids/url fragments can be permanent and don't change over time.

Something like:

## X.Y.Z

### X.Y.Z: Go builder

- **Added**: Added new input.
- **Changed**: Feature X was changed. 
@ianlewis ianlewis added the type:documentation Improvements or additions to documentation label Apr 3, 2023
@ianlewis ianlewis changed the title [docs] Split up CHANGELOG.md [docs] CHANGELOG: keepachangelog format May 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant