Add an initial document for our code style (#1141)

* Add an initial document for our code style

* add parameter types
This commit is contained in:
Leo Arias
2018-08-01 14:13:41 -06:00
committed by Nicolás Venturo
parent 5ae8aa4e2e
commit 89ccb03e6e

23
CODE_STYLE.md Normal file
View File

@ -0,0 +1,23 @@
# Code Style
We value clean code and consistency, and those are prerequisites for us to
include new code in the repository. Before proposing a change, please read this
document and take some time to familiarize yourself with the style of the
existing codebase.
## Solidity code
In order to be consistent with all the other Solidity projects, we follow the
[official recommendations documented in the Solidity style guide](http://solidity.readthedocs.io/en/latest/style-guide.html).
Any exception or additions specific to our project are documented below.
### Naming
* Parameters must be prefixed with an underscore.
```
function test(uint256 _testParameter1, uint256 _testParameter2) {
...
}
```