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

Add a changelog #55

Open
tsjohns9 opened this issue Jun 1, 2021 · 0 comments
Open

Add a changelog #55

tsjohns9 opened this issue Jun 1, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@tsjohns9
Copy link
Contributor

tsjohns9 commented Jun 1, 2021

Is your feature request related to a problem? Please describe.
A changelog has not been added to the project. Adding a changelog with a list of all the items that changed for a new release will help document what is being added to the project, and it will also help identify any breaking changes.

Describe the solution you'd like

  • Add a CHANGELOG.md file.
  • Add automation to the pipeline so that when a commit is added to main, the changelog is automatically updated to reflect what that change is.
  • Consider a commit message format to easily identify what the change is, and who made it.
@tsjohns9 tsjohns9 added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant