Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
corbym committed Jan 28, 2018
1 parent 8c1d636 commit bfc0c14
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@ There are only a few rules to helping out:
* Please write your tests first. And yes, I will be able to tell :)
* Any code you submit without test coverage at at least 95% (matching the coverage overall) will not be approved!
* Running go fmt is also a good idea.
* Remember to [golint](https://github.com/golang/lint).
* Public funcs and methods should always have godoc associated with them, starting with the name of the func/method. e.g. //MyFunc does so and so..
* Tests in the project do not necessarily match idiomatic go tests organisation, as I tend to write integration type unit tests rather than single package item unit tests. However,
any changes to existing code should have unit tests added at the package item level (new structs and funcs) where possible.
* Any broken tests should be corrected before submitting.
* Keep code modular and small. Functions over ten lines will not be accepted.
* Keep code modular and small. Functions over fifteen lines will not be accepted.
* Follow [idiomatic go coding guildelines](https://golang.org/doc/effective_go.html) whereever possible

Most importantly, however, *have fun*!

0 comments on commit bfc0c14

Please sign in to comment.