diff options
| -rw-r--r-- | docs/contributing.rst | 52 | ||||
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | docs/installing-solidity.rst | 6 |
3 files changed, 59 insertions, 0 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst new file mode 100644 index 00000000..32c83d8f --- /dev/null +++ b/docs/contributing.rst @@ -0,0 +1,52 @@ +############ +Contributing +############ + +Help is always appreciated! + +To get started, you can try :ref:`building-from-source` in order to familiarize +yourself with the components of Solidity and the build process. Also, it may be +useful to become well-versed at writing smart-contracts in Solidity. + +In particular, we need help in the following areas: + +* Improving the documentation +* Responding to questions from other users on `StackExchange + <http://ethereum.stackexchange.com/>`_ and the `Solidity Gitter + <https://gitter.im/ethereum/solidity>`_ +* Fixing and responding to `Solidity's GitHub issues + <https://github.com/ethereum/solidity/issues>`_ + +How to Report Issues +==================== + +To report an issue, please use the +`GitHub issues tracker <https://github.com/ethereum/solidity/issues>`_. When +reporting issues, please mention the following details: + +* Which version of Solidity you are using +* Which platform are you running on +* How to reproduce the issue +* What was the result of the issue +* What the expected behaviour is + +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. + +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 +Boost test cases and place them under ``test/``. + +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 +ensure that it builds locally before submitting a pull request. + +Thank you for your help! diff --git a/docs/index.rst b/docs/index.rst index a330172e..2c983d1e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -113,4 +113,5 @@ Contents security-considerations.rst style-guide.rst common-patterns.rst + contributing.rst frequently-asked-questions.rst diff --git a/docs/installing-solidity.rst b/docs/installing-solidity.rst index e500717b..e1322f12 100644 --- a/docs/installing-solidity.rst +++ b/docs/installing-solidity.rst @@ -1,3 +1,7 @@ +.. index:: ! installing + +.. _installing-solidity: + ################### Installing Solidity ################### @@ -68,6 +72,8 @@ We will re-add the pre-built bottles soon. brew linkapps solidity +.. _building-from-source: + Building from Source ==================== |