[DRAFT] Rework readme for contribution guideline #17
Conversation
|
Given scale (this is a lot more changes than the PR it merges into), I'm inclined to suggest it is a PR after mine. Let me see what Patrick's feedback is, as he's got comments incoming. Also I'm not sure linking developer resources into the README is a good idea, we already get a lot of people using these as support channels, which we're not equipped for. |
|
Developer resources in the Development information is important to be accessible even for non devs user. To know/understand and potentially participate in some decision. For example, some other user than devs should be aware of fees change, they are also concerned. An simplifaction/translation have to be done for sure, but ongoing devs should be accessible from outside.
I don't clearly understand what it means (what are support channels, used by who ?), so I don't understand the potential issue |
|
I've rebased this and pushed the result into a branch https://github.com/rnicoll/dogecoin/tree/contributing - can you grab a copy of that, check it's okay, and then raise it against dogecoin/dogecoin for the team to review please? |
|
I will wait a couple of day if I have some reactions to my different post and issue before push on Dogecoin repo. Like I said I thought it was more interesting to first define an accepted (or not rejected) roadmap, and after do some work. |
a44caf65f Merge bitcoin-core/univalue-subtree#28: Import fixes for sanitizer reported issues 135254331 Import fixes for sanitizer reported issues d5fb86940 refactor: use c++11 range based for loop in checkObject ff9c37930 refactor: Use nullptr (c++11) instead of NULL 08a99754d build: use ax_cxx_compile_stdcxx.m4 to check for C++11 support 66d3713ce Merge bitcoin-core/univalue-subtree#29: ci: travis -> cirrus 808d48729 ci: travis -> cirrus c390ac375 Merge bitcoin-core/univalue-subtree#19: Split sources for easier buildsystem integration 4a5b0a1c6 build: Move source entries out to sources.mk 6c7d94b33 build: cleanup wonky gen usage a222637 Merge #23: Merge changes from jgarzik/univalue@1ae6a23 98fadc0 Merge #24: Push bool into array correctly 5f03f1f Push bool into array correctly f77d0f7 Merge commit '1ae6a231a0169938eb3972c1d48dd17cba5947e1' into HEAD 98261b1 Merge #22: Clamp JSON object depth to PHP limit 54c4015 Clamp JSON object depth to PHP limit 5a58a46 Merge #21: Remove hand-coded UniValue destructor. b4cdfc4 Remove hand-coded UniValue destructor. 1ae6a23 Merge pull request dogecoin#57 from MarcoFalke/test_fix 92bdd11 univalue_write: remove unneeded sstream.h include ffb621c Merge pull request dogecoin#56 from drodil/remove_sstream_header f33acf9 Merge commit '7890db9~' into HEAD 7fba60b Merge #17: [docs] Update readme 4577454 Merge #13: Fix typo 66e0ade Remove unnecessary sstream header from univalue.h ac7e73c [docs] Update readme 7890db9 Merge #11: Remove deprecated std pair wrappers 88967f6 Version 1.0.4 40e3485 Merge #14: Cleaned up namespace imports to reduce symbol collisions 1dc113d Merge pull request dogecoin#50 from luke-jr/pushKV_bool 72392fb [tests] test pushKV for boolean values c23132b Pushing boolean value to univalue correctly 4a49647 Fix typo 85052a4 Remove deprecated std::pair wrappers 81faab2 Merge pull request dogecoin#48 from fwolfst/47-UPDATE_MIT_LINK_TO_HTTPS b17634e Update URLs to MIT license. 51d3ab3 Merge #10: Add pushKV(key, boolean) function (replaces #5) 129bad9 [tests] test pushKV for boolean values b3c44c9 Pushing boolean value to univalue correctly 07947ff Merge #9: [tests] Fix BOOST_CHECK_THROW macro ec849d9 [tests] Fix BOOST_CHECK_THROW macro 88ab64f Merge pull request dogecoin#46 from jasonbcox/master 35ed96d Merge pull request dogecoin#44 from MarcoFalke/Mf1709-univalue-cherrypick-explicit 420c226 Merge pull request dogecoin#45 from MarcoFalke/Mf1710-univalue-revert-test d208f98 Cleaned up namespace imports to reduce symbol collisions 31bc9f5 Merge #8: Remove unused Homebrew workaround fa04209 Remove HomeBrew workaround a523e08 Merge #7: Declare single-argument (non-converting) constructors "explicit" a9e53b3 Merge #4: Pull upstream fe805ea Declare single-argument (non-converting) constructors "explicit" 8a2d6f1 Merge pull request dogecoin#41 from jgarzik/get-obj-map ba341a2 Add getObjMap() helper method. Also, constify checkObject(). ceb1194 Handle .pushKV() and .checkObject() edge cases. 107db98 Add ::push_back(double) method for feature parity. d415300 Move one-line implementation of UniValue::read() to header. 52e85b3 Move exception-throwing get_* methods into separate implementation module. dac5296 README.md: update code quotes 3e31dcf README.md: close code quote d09b842 Update README.md f1b86ed Convert README to markdown style. 1dfe464 Import UniValue class unit tests from bitcoin project. 0d3e74d operator[] takes size_t index parameter (versus unsigned int) 640158f Private findKey() method becomes size_t clean, and returns bool on failure. 7099135 Merge pull request dogecoin#36 from ryanofsky/pr/end-str a31231b Version 1.0.3 4fd5444 Reject unterminated strings 81eba33 Merge pull request #26 from isle2983/pushBackHelpers 3640541 Merge PR #32 from branch 'nul-not-special' of git://github.com/ryanofsky/univalue into merge 89bb073 Merge pull request #31 from ryanofsky/raw-literals 511008c Merge pull request #30 from ryanofsky/test-driver 77974f3 Merge pull request dogecoin#34 from paveljanik/20161116_Wshadow_codepoint a38fcd3 Do not shadow member variable codepoint. fd32d1a Don't require nul-terminated string inputs 0bb1439 Support parsing raw literals in UniValue 28876d0 Merge pull request #29 from btcdrak/exportspace 839ccd7 Add test driver for JSONTestSuite 26ef3ff Remove trailing whitespace from JSON export cfa0384 Convenience wrappers for push_back-ing integer types git-subtree-dir: src/univalue git-subtree-split: a44caf65fe55b9dd8ddb08f04c0f70409efd53b3
Redo the readme, make it easier/shorter and less developer focused.
Keep more general info, redirect more to other file to reduce the amount of infos.
[Not sure if it's the best way to push commits, I'm struggling with git to add commit to a PR where I do not have rights on the repo]
PS.: Not a native english speaker (you probably already saw it I think), perhaps some sentences construction are bad.