Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upGitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
Add a changelog #589
Add a changelog #589
Comments
|
Hi, can I work on this? |
|
Absolutely! Make a pull request with your work and wemll take a look! Ideally it would be nice to have a log going back to the first release, and also to have documentation about how the changelog should be kept up, whether it uses the Keep a Changelog, another format or your own. :)
\-------- Original Message --------
On Dec 24, 2019, 12:04 AM, Krishnanunni < ***@***.***> wrote:
Hi, can I work on this?
—
You are receiving this because you authored the thread.
Reply to this email directly, [view it on GitHub][], or [unsubscribe][].![AEE3WD2YHKN2LUARUIZMIP3Q2GRANA5CNFSM4J4MQFIKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEHSR7ZI.gif][]
[view it on GitHub]: #589?email_source=notifications&email_token=AEE3WD53MB4XHXLL2RTQGMTQ2GRANA5CNFSM4J4MQFIKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEHSR7ZI#issuecomment-568664037
[unsubscribe]: https://github.com/notifications/unsubscribe-auth/AEE3WDYWRJ3XNA52WVZNGFTQ2GRANANCNFSM4J4MQFIA
[AEE3WD2YHKN2LUARUIZMIP3Q2GRANA5CNFSM4J4MQFIKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEHSR7ZI.gif]: https://github.com/notifications/beacon/AEE3WD2YHKN2LUARUIZMIP3Q2GRANA5CNFSM4J4MQFIKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEHSR7ZI.gif
|
|
Hi, I have made a pull request for the issue. I have used the auto-changelog package to generate the changelog, using the Keep a Changelog template. The 'auto-changelog' package is also used with release-it, making it suitable on adoption of a release management tool like release-it. For now, I have made use of their automated tool which makes use of the 'git log' command to generate the 'CHANGELOG.md' file. I am not sure whether it provides the clarity that is expected as it simply differentiates the commits based on whether it was the result of a merge, an issue fix or simply a commit. This is the pull request. Please have a look and I would be very grateful if you could suggest me how to improve on this. |
As we attempt to pick up the release cadence, we are in need of an explicit changelog file which enumerates changes in each version. This should be a markdown or plaintext file adhering to some form of standardized format. Ideally, it will be able to work with #582.