Skip to content

Latest commit

 

History

History
50 lines (27 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

50 lines (27 loc) · 1.38 KB

How to contribute

Bug reports and pull requests from users are what keep this project working.

Basics

  1. Create an issue and describe your idea
  2. Fork it
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Commit your changes (git commit -am 'Add some feature')
  5. Publish the branch (git push origin my-new-feature)
  6. Create a new Pull Request

Setup a GIT precommit hook

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

Checking your work

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.

Write documentation

This project has documentation in a few places:

Introduction and usage

A friendly README.md written for many audiences.

Examples and advanced usage

In the examples folder.

API documentation

Our API documentation is auogenerated by GoDoc and will be published upon merge of your Pull Request to our package GoDoc page