bitcoin-development icon indicating copy to clipboard operation
bitcoin-development copied to clipboard

Clean this up and add as a doc to Bitcoin Core repo?

Open michaelfolkson opened this issue 4 years ago • 1 comments

https://github.com/jonatack/bitcoin-development/blob/master/how-to-review-bitcoin-core-prs.md

This is really great and I wonder if a version of it should be added to the Bitcoin Core repo. Either as a standalone doc on reviewer-notes or as a reviewer section in the developer notes: https://github.com/bitcoin/bitcoin/blob/master/doc/developer-notes.md

Let me know what you think. I'd like to add some resources to it if it is going to be a general resource rather than merely your own personal resource. Jeremy Rubin's presentation, transcript on contributing to Bitcoin Core and also some guidance on setting up and using ctags.

http://diyhpl.us/wiki/transcripts/sf-bitcoin-meetup/2018-04-23-jeremy-rubin-bitcoin-core/

michaelfolkson avatar Jul 21 '19 13:07 michaelfolkson

Thanks @michaelfolkson! Feel free to propose additions and improvements. I see this as a WIP that is temporarily incubated here but intended to be published more officially at some point as a general resource, e.g. in its own repository as a collaborative static website or mini e-book, etc.

(FWIW I doubt the Bitcoin Core maintainers would want the additional burden of maintaining this large document in the Bitcoin Core codebase, where review resources are already in short supply.)

Also, the document is becoming quite large and should probably be separated out into different parts, like the section on How to Make PRs, the more technical details of PR reviewing versus the general ideas, how to learn C++, etc.

jonatack avatar Jul 24 '19 13:07 jonatack