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 #58

Closed
3 tasks done
tajmone opened this issue Mar 1, 2020 · 0 comments
Closed
3 tasks done

Add CHANGELOG #58

tajmone opened this issue Mar 1, 2020 · 0 comments
Labels
📚 CHANGELOG Documenting changes between releases 📚 documentation Improvements or additions to documentation

Comments

@tajmone
Copy link
Owner

tajmone commented Mar 1, 2020

With the upcoming v1.1.0 update we need to start tracking changes between releases of the AsciiDoc port of Hugo Book.

We could either add a "Changes" section in the main README or create an independent CHANGELOG.md document; the former solution seems better to start off with, and when the list becomes long we could then move it to the independent CHANGELOG.md document.

  • Create a CHANGELOG label to track issues relating to updating the ChangeLog.
  • Add to main README.md a "Changes" section:

As for the details of the changes list, we could the list brief by providing reference links to the various Issues and commits, and just keep a brief resume in the text description.

@tajmone tajmone added 📚 documentation Improvements or additions to documentation 📚 CHANGELOG Documenting changes between releases labels Mar 1, 2020
tajmone added a commit that referenced this issue Mar 2, 2020
in main README doc:

* Add new "Changelog" section (see #58).
* In "Acknowledgements" section, credit Roody Yogurt, Nikos Chantziaras
  and Juhana Leinonen for the annotated Hugo Book PDF (see #57).
* Update release badge to v1.1.0 (see #68).
@tajmone tajmone closed this as completed Mar 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 CHANGELOG Documenting changes between releases 📚 documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant