aboutsummaryrefslogtreecommitdiffstats
path: root/docs/contributing.rst
diff options
context:
space:
mode:
authorchriseth <c@ethdev.com>2016-09-05 22:29:08 +0800
committerchriseth <c@ethdev.com>2016-09-07 01:11:41 +0800
commit4f5a95d569408e6a0a94c54b1eb39ea62b873c5e (patch)
treee0624ae19d837fb8e2acf9f828c4464e9e788c60 /docs/contributing.rst
parentfbe0edb32c973166efbd5c0ac556f37fd38584d6 (diff)
downloaddexon-solidity-4f5a95d569408e6a0a94c54b1eb39ea62b873c5e.tar
dexon-solidity-4f5a95d569408e6a0a94c54b1eb39ea62b873c5e.tar.gz
dexon-solidity-4f5a95d569408e6a0a94c54b1eb39ea62b873c5e.tar.bz2
dexon-solidity-4f5a95d569408e6a0a94c54b1eb39ea62b873c5e.tar.lz
dexon-solidity-4f5a95d569408e6a0a94c54b1eb39ea62b873c5e.tar.xz
dexon-solidity-4f5a95d569408e6a0a94c54b1eb39ea62b873c5e.tar.zst
dexon-solidity-4f5a95d569408e6a0a94c54b1eb39ea62b873c5e.zip
Update documentation to version 0.4.0.
Diffstat (limited to 'docs/contributing.rst')
-rw-r--r--docs/contributing.rst8
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst
index cef6dfd2..a316abd6 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -25,17 +25,21 @@ To report an issue, please use the
reporting issues, please mention the following details:
* Which version of Solidity you are using
+* What was the source code (if applicable)
* Which platform are you running on
* How to reproduce the issue
* What was the result of the issue
* What the expected behaviour is
+Reducing the source code that caused the issue to a bare minimum is always
+very helpful and sometimes even clarifies a misunderstanding.
+
Workflow for Pull Requests
==========================
In order to contribute, please fork off of the ``develop`` branch and make your
-changes there. Your commit messages should detail *why* you made your change, as
-opposed to *what* you did.
+changes there. Your commit messages should detail *why* you made your change
+in addition to *what* you did (unless it is a tiny change).
If you need to pull in any changes from ``develop`` after making your fork (for
example, to resolve potential merge conflicts), please avoid using ``git merge``