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

Make commits conform to mkchlog format #155

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Kixunil
Copy link

@Kixunil Kixunil commented Oct 26, 2023

This introduces mkchlog to the project so that the changelog could be auto-generated.

This introduces mkchlog to the project so that the changelog could be
auto-generated.

changelog:
	section: dev
	inherit: title
	title-is-enough: true
Copy link
Member

@apoelstra apoelstra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 41aaf77

@apoelstra
Copy link
Member

cc @tcharding could you take a look at this one since you've been more active in the rust-bitcoin equivalent?

Copy link
Member

@tcharding tcharding left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 41aaf77

@tcharding
Copy link
Member

tcharding commented Oct 27, 2023

Looks good, probably want to let @clarkmoody ack this though because introducing this requires devs to learn the new tool, took me about 15 mins to read the docs and play around with it.

Clark, the idea, if you are ok with it, would be to merge this PR and then #141

This was referenced Oct 27, 2023
@tcharding
Copy link
Member

I threw #151 on top of this branch locally and ran mkchlog gen, which led to crywolf/mkchlog#18

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?

@Kixunil
Copy link
Author

Kixunil commented Oct 27, 2023

@tcharding yes, output issues can be solved in parallel. Just checking is enough for now.

@clarkmoody
Copy link
Member

Is there any documentation for this change? How would a new contributor know what to do?

@tcharding
Copy link
Member

tcharding commented Nov 1, 2023

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 mkchlog and link it.

@tcharding
Copy link
Member

Might be worth putting a decent effort into it here since we can then copy'n'paste to every other repo as we introduce mkchlog.

@Kixunil
Copy link
Author

Kixunil commented Nov 2, 2023

I was thinking of making a guide to (new) contributors that woul live directly in mkchlog repo and could be linked.

@tcharding
Copy link
Member

The docs in the mkchlog readme are pretty good already. Just a few short well worded sentences and a link was all I had in mind.

@Kixunil
Copy link
Author

Kixunil commented Nov 3, 2023

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").

@tcharding
Copy link
Member

Fair point

@clarkmoody
Copy link
Member

What do we need to make progress on this?

@tcharding
Copy link
Member

From my perspective this is good to go, mkchlog is so new I'm ok to deal with teething problems as we go, like explaining how to use it to any new contributor. Soon as better docs are available we will remember to link to them I rekon since we will hopefully be adopting this org wide. Just my 2 cents.

@tcharding
Copy link
Member

What do we need to make progress on this?

An ACK from you I rekon @clarkmoody.

@tcharding
Copy link
Member

Or were you waiting on docs improvements (in the mkchlog repo or here) @clarkmoody ?

@clarkmoody
Copy link
Member

Or were you waiting on docs improvements (in the mkchlog repo or here) @clarkmoody ?

I would expect at least some note to contributors in the README with a link to external docs.

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

Successfully merging this pull request may close these issues.

None yet

4 participants