diff options
author | obscuren <geffobscura@gmail.com> | 2014-01-11 22:41:05 +0800 |
---|---|---|
committer | obscuren <geffobscura@gmail.com> | 2014-01-11 22:41:05 +0800 |
commit | d6f7372a3c5b002c6e385b5916bd5f81463c37df (patch) | |
tree | 060055a985aaf63a642496770b23baa8e0dbe766 | |
parent | 9571a512861d4a44c36d368f4baa15b2aa81c37d (diff) | |
download | go-tangerine-d6f7372a3c5b002c6e385b5916bd5f81463c37df.tar.gz go-tangerine-d6f7372a3c5b002c6e385b5916bd5f81463c37df.tar.zst go-tangerine-d6f7372a3c5b002c6e385b5916bd5f81463c37df.zip |
Coding style
-rw-r--r-- | README.md | 25 |
1 files changed, 24 insertions, 1 deletions
@@ -25,4 +25,27 @@ Command line options Contribution ============ -See CONTRIB.md +If you'd like to contribute to Ethereum Go please fork, fix, commit and +send a pull request. Commits who do not comply with the coding standards +are ignored. + +Coding standards +================ + +Sources should be formatted according to the [Go Formatting +Style](http://golang.org/doc/effective_go.html#formatting). + +Unless structs fields are supposed to be directly accesible, provide +Getters and hide the fields through Go's exporting facility. + +Don't "overcomment", meaning that your and my mom doesn't have to read +the source code. + +*wrong* + +```go +// Check if the value at x is greater than y +if x > y { + // It's greater! +} +``` |