So you want to contribute? Yay, I really appreciate this! Please read the following notes to make life easy for both you and me.
Please note: This is the first version of a contributor guide. I don't know whether this will work ;-)
-
Please check the issues on github if the bug was already reported. If so: feel free to add a comment if you think it helps.
-
Not previously reported? Please open an issue. Please describe how I can reproduce the issue (what environment, commandline parameters, attached devices, ...).
For small changes (typos etc.), just open a pull request. For anything bigger, please open an issue first. Describe what you want to do (bugfix, implement new feature, solve existing issue) and give a quick overview on how you would like to implement it. I hope to reduce frustration for both you and me if we agree on a solution strategy before writing code.
In any way: Your code should be formatted using
gofmt.
All documentation lives within this repository. If you spot an error or want to improve the documentation, please create a pull request. For small changes just create the pull request directly. For big changes ("This sucks, I want to rewrite it") create an issue first.