diff options
| author | Riccardo Spagni <ric@spagni.net> | 2017-04-24 10:44:10 +0200 |
|---|---|---|
| committer | Riccardo Spagni <ric@spagni.net> | 2017-04-24 10:44:10 +0200 |
| commit | 3d59ec7e688cb124f22af368c534d1e5d50d4b2a (patch) | |
| tree | 870a2d0e665b0d0d4265f92d3a7ac9531f279f0f | |
| parent | Merge pull request #1961 (diff) | |
| parent | mv "Contributing" above install, compile, etc (diff) | |
| download | monero-3d59ec7e688cb124f22af368c534d1e5d50d4b2a.tar.xz | |
Merge pull request #1962
aa02ff7f mv "Contributing" above install, compile, etc (Mike C)
a55bb375 Add link to CONTRIBUTING to README.md (Mike C)
09bbf96d Grouping CONTRIBUTING into digestable sections (Mike C)
dc35c736 Rename CONTRIBUTING to CONTRIBUTING.md (Mike C)
| -rw-r--r-- | CONTRIBUTING.md (renamed from CONTRIBUTING) | 24 | ||||
| -rw-r--r-- | README.md | 8 |
2 files changed, 18 insertions, 14 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING.md index 55fcedccd..78d78f7bf 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING.md @@ -1,8 +1,17 @@ -A good way to help is to test, and report bugs. -See http://www.chiark.greenend.org.uk/~sgtatham/bugs.html if you -want to help that way. Testing is invaluable in making a piece +# Contributing to Monero + +A good way to help is to test, and report bugs. See +[How to Report Bugs Effectively (by Simon Tatham)](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html) +if you want to help that way. Testing is invaluable in making a piece of software solid and usable. + +## General Guidelines + +* Comments are encouraged. +* If modifying code for which Doxygen headers exist, that header must be modified to match. +* Tests would be nice to have if you're adding functionality. + Patches are preferably to be sent via a github pull request. If that can't be done, patches in "git format-patch" format can be sent (eg, posted to fpaste.org with a long enough timeout and a link @@ -16,15 +25,12 @@ modifying is encourgaged. Proper squashing should be done (eg, if you're making a buggy patch, then a later patch to fix the bug, both patches should be merged). +## Commits and Pull Requests + Commit messages should be sensible. That means a subject line that describes the patch, with an optional longer body that gives details, documentation, etc. -Comments are encouraged. - -If modifying code for which Doxygen headers exist, that header must -be modified to match. - When submitting a pull request on github, make sure your branch is rebased. No merge commits nor stray commits from other people in your submitted branch, please. You may be asked to rebase if there @@ -32,5 +38,3 @@ are conflicts (even trivially resolvable ones). PGP signing commits is strongly encouraged. That should explain why the previous paragraph is here. - -Tests would be nice to have if you're adding functionality. @@ -80,6 +80,10 @@ There are also several mining pools that kindly donate a portion of their fees, See [LICENSE](LICENSE). +# Contributing + +If you want to help out, see [CONTRIBUTING](CONTRIBUTING.md) for a set of guidelines. + ## Monero software updates and consensus protocol changes (hard fork schedule) Monero uses a fixed-schedule hard fork mechanism to implement new features. This means that users of Monero (end users and service providers) need to run current versions and update their software on a regular schedule. Here is the current schedule, versions, and compatibility. @@ -378,10 +382,6 @@ While monerod and monero-wallet-cli do not use readline directly, most of the fu Note: rlwrap will save things like your seed and private keys, if you supply them on prompt. You may want to not use rlwrap when you use simplewallet to restore from seed, etc. -# Contributing - -If you want to help out, see CONTRIBUTING for a set of guidelines. - # Debugging This section contains general instructions for debugging failed installs or problems encountered with Monero. First ensure you are running the latest version built from the github repo. |