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

Changelog and/or Release Notes #197

Open
greyscaled opened this issue Apr 20, 2021 · 3 comments
Open

Changelog and/or Release Notes #197

greyscaled opened this issue Apr 20, 2021 · 3 comments

Comments

@greyscaled
Copy link
Contributor

It would nice to have a changelog or use GitHub release notes with each released tag of doctoc for ease of upgrade by consumers.

For the major upgrade of 1.4 -> 2.0, I largely relied on using this view:

v1.4.0...v2.0.0

@AndrewSouthpaw
Copy link
Collaborator

Sounds like an excellent opportunity for someone to contribute to an OSS project! 🎉

Feel free to gather inspiration from another favorite changelog and apply it here.

@testrDEV
Copy link

testrDEV commented Sep 7, 2021

Hi,
I can work on this issue and make a changelog for the major updates, But it'd take some as I am new to contributing to OSS projects and still learning all the version control etiquette.
Thanks!

@thlorenz
Copy link
Owner

thlorenz commented Sep 9, 2021

@testrDEV go for it! Ideally it'd include links like @vapurrmaid suggested.
Don't worry too much about documenting the changes for now .. the links are gonna be handy with minimal annotations.

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

Successfully merging a pull request may close this issue.

4 participants