From d6f7372a3c5b002c6e385b5916bd5f81463c37df Mon Sep 17 00:00:00 2001 From: obscuren Date: Sat, 11 Jan 2014 15:41:05 +0100 Subject: [PATCH] Coding style --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 37e8505f1..a9bb8b260 100644 --- a/README.md +++ b/README.md @@ -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! +} +```