-
Notifications
You must be signed in to change notification settings - Fork 172
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
doc: Replace coding.txt with Bitcoin developer-notes.md #2186
base: development
Are you sure you want to change the base?
doc: Replace coding.txt with Bitcoin developer-notes.md #2186
Conversation
In particular I will start out with referencing a discussion the core devs were having in #2177. @cyrossignol made some good comments which I will repeat below: As an aside, these are the rough guidelines for managing legacy code style that seem standard in most teams that I've worked on:
Of course, we need an up-to-date style guide for any of this to really matter. I think we do a decent job following these points so far (I surely haven't done so absolutely myself). I mention these because formalizing our position should save us time—I'd rather discuss and review style changes as little as possible. No convention or tool set is perfect, though. The goal is to minimize the distraction of code style from the review process—both for new reviews (PRs) and historical (git log/blame, change tracking, etc.)—so I propose these guidelines as a starting point. Note that bullet number 2 above is different than the stance taken in Bitcoin developer-notes.md in the Coding Style (General) section. |
showing up in the command list. | ||
|
||
- Use *invalid* bech32 addresses (e.g. in the constant array `EXAMPLE_ADDRESS`) for | ||
`RPCExamples` help documentation. |
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.
not applicable?
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.
No, I think it is. We should not be using valid Gridcoin address in RPC examples.
This replaces our severely outdated coding.txt style guide with Bitcoin's developer notes markdown document. The Bitcoin style is what the core devs have been following in large part with the new code for Gridcoin.
Co-authored-by: div72 <[email protected]>
571e133
to
ef1158c
Compare
This PR is a tracking/discussion PR that starts with replacing our severely outdated coding.txt style guide with Bitcoin's developer notes markdown document. The Bitcoin style is what the core devs have been following in large part with the new code for Gridcoin.
I am marking this as draft, and welcome discussion on this to fine tune it for our blockchain with additional change commits prior to merging.