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.

Sign up for GitHub

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

Jump to bottom

Add a CHANGELOG file #32

Closed
John15321 opened this issue Aug 15, 2022 · 2 comments · Fixed by #39
Closed

Add a CHANGELOG file #32

John15321 opened this issue Aug 15, 2022 · 2 comments · Fixed by #39
Assignees
@Allstreamer
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Milestone
📃 Documentation

Comments

@John15321
Copy link
Collaborator

Add a changelog file. What is a changelog file:
@John15321 John15321 added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Aug 15, 2022
This was referenced Aug 15, 2022
Open
Open
Open
@John15321 John15321 changed the title Add a CHANGELOG file Add a CHANGELOG file Aug 15, 2022
@Allstreamer Allstreamer self-assigned this Aug 18, 2022
@Allstreamer Allstreamer linked a pull request Aug 18, 2022 that will close this issue
[32] Add a CHANGELOG file #38
Closed
@John15321 John15321 linked a pull request Aug 23, 2022 that will close this issue
[#32] Add a Changelog file #39
Merged
@dawnofmidnight
Copy link

Can I suggest that the CHANGELOG.md simply links to the book (or vice versa)? Maintaining two sounds like kind of a pain, whereas you could just link to the generated mdbook file (either the source file or the hosted version (GitHub pages?)).

@John15321
Copy link
Collaborator Author

Can I suggest that the CHANGELOG.md simply links to the book (or vice versa)? Maintaining two sounds like kind of a pain, whereas you could just link to the generated mdbook file (either the source file or the hosted version (GitHub pages?)).

that's the point of this issue #34

John15321 pushed a commit that referenced this issue Sep 13, 2022
@Allstreamer
[#32] Add a Changelog file (#39)
480cf4a 
- Added `CHANGELOG.md` based on [Keep a
Changelog](https://keepachangelog.com/en/1.0.0/) template
- Added Dev-branch changelogs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Allstreamer Allstreamer

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
📃 Documentation
3 participants
@Allstreamer @John15321 @dawnofmidnight