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

Allow blank sections under the unreleased section #27

Open
h-artzi opened this issue Jul 14, 2020 · 0 comments
Open

Allow blank sections under the unreleased section #27

h-artzi opened this issue Jul 14, 2020 · 0 comments

Comments

@h-artzi
Copy link

h-artzi commented Jul 14, 2020

Is your feature request related to a problem? Please describe.

Can't add blank sections under the unreleased section of the changelog.

A clear and concise description of what the problem is. Ex.I would like to see [...] because [...].
Please include the intended use case and what the feature would improve on so that we can prioritize
the feature accordingly.

We would like to add the following sections under the Unreleased section of a changelog after a version release.

### Added
### Changed
### Deprecated
### Removed
### Fixed
### Security

This would ensure that developers are aware of all the possible sections they can add to while updating the Changelog.
Then when we cut the next release, we would be in charge of removing the unused sections.

Describe the solution you would like

Allow the use of blank sections in the Unreleased section as long as they are part of the following set (added, changed, deprecated, removed, fixed, security)

Describe alternatives you have considered

  • Not having this in the changelog, and developers potentially misplacing entries.
  • The use of a dummy entry such as This is a dummy entry

Additional context

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

1 participant