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 changelog to track document changes #879

Open
wareid opened this issue Oct 26, 2021 · 1 comment
Open

Add changelog to track document changes #879

wareid opened this issue Oct 26, 2021 · 1 comment

Comments

@wareid
Copy link
Contributor

wareid commented Oct 26, 2021

Add a changelog section to the end of the document outlining the details of major changes (i.e. substantive changes to text). This could accompany version releases and would only need to summarize the text change. Could link to the release information in GH, but serves as a quick reference within the document for those less comfortable with GH and navigating releases/commits in a repo.

@karlgroves
Copy link
Owner

Thanks for this suggestion. I'm currently looking into how to automate this via a GH action.

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

No branches or pull requests

2 participants