Updated readme and coding standards

pull/9/head
obscuren 11 years ago
parent 4ea93eba50
commit 64058e2663
  1. 15
      README.md

@ -26,8 +26,10 @@ Install
Command line options
====================
```
-c launch the developer console
-m start mining fake blocks and broadcast fake messages to the net
```
Contribution
============
@ -45,8 +47,8 @@ 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.
When you comment put meaningfull comments. Describe in detail what you
want to achieve.
*wrong*
@ -57,6 +59,15 @@ if x > y {
}
```
Everyone reading the source probably know what you wanted to achieve
with above code. Those are **not** meaningful comments.
While the project isn't 100% tested I want you to write tests non the
less. I haven't got time to evaluate everyone's code in detail so I
expect you to write tests for me so I don't have to test your code
manually. (If you want to contribute by just writing tests that's fine
too!)
### Copy
69bce990a619e747b4f57483724b0e8a1732bb3b44ccf70b0dd6abd272af94550fc9d8b21232d33ebf30d38a148612f68e936094b4daeb9ea7174088a439070401 0255c78815d4f056f84c96de438ed9e38c69c0f8af24f5032248be5a79fe9071c3

Loading…
Cancel
Save