-
Notifications
You must be signed in to change notification settings - Fork 51
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
Make commits conform to mkchlog format #155
base: master
Are you sure you want to change the base?
Conversation
This introduces mkchlog to the project so that the changelog could be auto-generated. changelog: section: dev inherit: title title-is-enough: true
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ACK 41aaf77
cc @tcharding could you take a look at this one since you've been more active in the rust-bitcoin equivalent? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ACK 41aaf77
Looks good, probably want to let @clarkmoody ack this though because introducing this requires Clark, the idea, if you are ok with it, would be to merge this PR and then #141 |
I threw #151 on top of this branch locally and ran But I think we can still merge this and the fix will be ready by the time we do another release, @Kixunil do you agree? |
@tcharding yes, output issues can be solved in parallel. Just checking is enough for now. |
Is there any documentation for this change? How would a new contributor know what to do? |
Oh good point, while I was playing around I wrote a whole bunch of docs in the README (I think it was in this repo) then deleted it all because it got too close to whats already in the mkchlog repo's README. We should definitely mention |
Might be worth putting a decent effort into it here since we can then copy'n'paste to every other repo as we introduce |
I was thinking of making a guide to (new) contributors that woul live directly in |
The docs in the |
They are geared towards maintainers ("why and how should you use this in your project"), not towards contributors ("what should you do to get your contribution in ASAP"). |
Fair point |
What do we need to make progress on this? |
From my perspective this is good to go, |
An ACK from you I rekon @clarkmoody. |
Or were you waiting on docs improvements (in the |
I would expect at least some note to contributors in the README with a link to external docs. |
This introduces mkchlog to the project so that the changelog could be auto-generated.