#160 Adds changelog, including Lightchain historical progress#169
#160 Adds changelog, including Lightchain historical progress#169EnchanterIO wants to merge 1 commit intomasterfrom
Conversation
EnchanterIO
commented
May 30, 2019
EnchanterIO
commented
- Updated all relevant documentation in docs
- Updated all code comments where relevant
- Wrote tests
EnchanterIO
added
the
enhancement
ggarri
left a comment
ggarri
left a comment
There was a problem hiding this comment.
IMO the auto-generation of the CHANGELOG seems a great idea but I would rather remove the sections of Close Issues and Pull Requests as it is quite redundant, Bug and Improvements are enough to show the progress.
In addition to the autogenerated version we could tune it a bit to make it more readable as our issue titles might not be the best to understand the work done behind them.
I was thinking about that as well but then I came to the conclusion that changelog is for grouping progress per tags into timeline and shows what happened in the repository in general. So I find Close issues and pull requests useful. Even more readable version of the changelog with titles and everything is the That being said, we can also add titles to the changelog, it may improve it a bit. |
ggarri
left a comment
ggarri
left a comment
There was a problem hiding this comment.
It would be good to do a clean it up before merging as many of the PR and issues have not descriptive messages
There was a problem hiding this comment.
Waiting for team agreement on CHANGELOG format. I did a quick research on other projects in our ecosystem I got the the following examples, all of them valid in my opinion:
None of them appears to be autogenerated and I would be more included for an autogenerated version but in order to produce a "good looking" version we would need to go back in our issues and PRs and rewrite them having a common convention.
EnchanterIO
changed the title
2 participants
