doc: Add non-style-related development guidelines #7003

pull laanwj wants to merge 1 commits into bitcoin:master from laanwj:2015_11_development_guidelines changing 1 files +169 −0

laanwj commented at 11:03 AM on November 13, 2015: member

I've collected these over time, mostly adding notes after troubleshooting obscure bugs. As I hope to get the community more involved in the whole process, I think it is useful to add to the developer-notes.

doc: Add non-style-related development guidelines

I've collected these over time, mostly adding notes after
troubleshooting obscure bugs. As I hope to get the community more
involved in the whole process, I think it is useful to add to the
developer-notes.

b8c06ef409

laanwj added the label Docs and Output on Nov 13, 2015
jonasschnelli commented at 2:52 PM on November 13, 2015: contributor

Nice. I think this is very helpful for new devs (and even for old hands).

I would say we should take these new point directly at the 2nd position above of "doxygen comments".
paveljanik commented at 3:50 PM on November 13, 2015: contributor

These are gems! Thank you for collecting all these notes. They help a lot!
petertodd commented at 7:53 PM on November 14, 2015: contributor

Awesome, thanks! @paveljanik I'd prefer dots at the end of sentences too.

ACK
gmaxwell commented at 9:32 PM on November 14, 2015: contributor

ACK (with or without my suggestions), this is all good stuff.
sipa commented at 9:59 PM on November 14, 2015: member

Very ACK.
gavinandresen commented at 10:10 PM on November 14, 2015: contributor

ACK. Very nice!

in doc/developer-notes.md:None in b8c06ef409

 216 | +- New features should be exposed on RPC first, then can be made available in the GUI
 217 | +
 218 | +  - *Rationale*: RPC allows for better automatic testing. The test suite for
 219 | +    the GUI is very limited
 220 | +
 221 | +- Make sure pulls pass Travis CI before merging

omefire commented at 1:14 AM on November 15, 2015:

very minor nitpick: instead 'pulls', should we make it 'pull requests' ?

in doc/developer-notes.md:None in b8c06ef409

 228 | +    be done first 
 229 | +
 230 | +Wallet
 231 | +-------
 232 | +
 233 | +- Make sure that that no crashes happen with run-time option `-disablewallet`.

omefire commented at 1:15 AM on November 15, 2015:

nitpick: 'that' appears twice.

omefire commented at 2:02 AM on November 15, 2015: none

Thanks, these are helpful, especially for folks like me, ramping up on the codebase and planning to start contributing code.
sipa merged this on Nov 28, 2015
sipa closed this on Nov 28, 2015
sipa referenced this in commit 8332457e95 on Nov 28, 2015
sipa commented at 1:15 PM on November 28, 2015: member

@onefire Reasonable nits, but no reason to hold this up, IMHO. Feel free to submit improvements.
paveljanik commented at 3:47 PM on November 28, 2015: contributor

@onefire While doing so, please fix also the nits I brought. Thank you.
MarcoFalke locked this on Sep 8, 2021

Contributors

Labels

Linked (view graph)

#25292 Add LogPrintLevel to lint-format-strings, drop LogPrint-vs-LogPrintf section in dev notes