aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBob Summerwill <bob@summerwill.net>2016-08-30 02:19:21 +0800
committerGitHub <noreply@github.com>2016-08-30 02:19:21 +0800
commit29b8965b9541e75905bb688954649ee7b0b0fefc (patch)
tree203ed96a82440b75d07fc2cc754a52cab23360e5
parent0b89e1e98ce75ba4ed9ecd7b2e5de2f51a810622 (diff)
parent30f12885375c9c05158881995f81598da0087d6b (diff)
downloaddexon-solidity-29b8965b9541e75905bb688954649ee7b0b0fefc.tar
dexon-solidity-29b8965b9541e75905bb688954649ee7b0b0fefc.tar.gz
dexon-solidity-29b8965b9541e75905bb688954649ee7b0b0fefc.tar.bz2
dexon-solidity-29b8965b9541e75905bb688954649ee7b0b0fefc.tar.lz
dexon-solidity-29b8965b9541e75905bb688954649ee7b0b0fefc.tar.xz
dexon-solidity-29b8965b9541e75905bb688954649ee7b0b0fefc.tar.zst
dexon-solidity-29b8965b9541e75905bb688954649ee7b0b0fefc.zip
Merge pull request #968 from Denton-L/contributing
Update README to link to new contribution section
-rw-r--r--README.md3
-rw-r--r--docs/contributing.rst5
2 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index e054cb08..bda66996 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,6 @@ Solidity is still under development. So please do not hesitate and open an [issu
See the [Solidity documentation](http://solidity.readthedocs.io/en/latest/installing-solidity.html#building-from-source) for build instructions.
## How to Contribute
-This repository uses the same [coding style](https://github.com/ethereum/cpp-ethereum/blob/develop/CodingStandards.txt) as
-all of the cpp-ethereum projects. Please try to align with us in the Gitter channel before making larger changes.
+Please see our contribution guidelines in [the Solidity documentation](http://solidity.readthedocs.io/en/latest/contributing.html).
Any contributions are welcome!
diff --git a/docs/contributing.rst b/docs/contributing.rst
index 32c83d8f..cef6dfd2 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -41,9 +41,12 @@ 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``
and instead, ``git rebase`` your branch.
-Additionally, if you are writing a feature, please ensure you write appropriate
+Additionally, if you are writing a new feature, please ensure you write appropriate
Boost test cases and place them under ``test/``.
+However, if you are making a larger change, please consult with the Gitter
+channel, first.
+
Finally, please make sure you respect the `coding standards
<https://raw.githubusercontent.com/ethereum/cpp-ethereum/develop/CodingStandards.txt>`_
for this project. Also, even though we do CI testing, please test your code and