Bug reports and pull requests from users are what keep this project working.
- Create an issue and describe your idea
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Publish the branch (
git push origin my-new-feature) - Create a new Pull Request
The docs are autogenerated from the code and the following pre-commit hook will validate needed generation is preformed upon a commit.
In file .git/hooks/pre-commit
make precommithook
Dont forget to make the file executable
chmod +x .git/hooks/pre-commit
You can run the test suite.
You can run Metalinter to check code style.
We recommend the metalint Make task, which will build, test and validate the code style of the code.
This project has documentation in a few places:
A friendly README.md written for many audiences.
In the examples folder.
Our API documentation is auogenerated by GoDoc and will be published upon merge of your Pull Request to our package GoDoc page