Contributing

This repository is open to contributions from anyone, but please discuss the change(s) you wish to make by opening an issue first.

If you are unsure where to start, you can look at issues tagged as help wanted or good first issue.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Workflow

We use git flow (with the aid of git-flow-avh) for the development of Hussar. If you are unfamiliar with git flow, read through this very quick guide. All contributions should be made as a feature, hotfix or bugfix as appropriate.

Pull Request Process

  1. Use gofmt -s, golint and go vet. If Go Report Card gives your branch close to 100% (except for gocyclo), you should be good.
  2. Try to use a coding style consistent with the one already used.
  3. Ensure any added code is tested (where applicable).
  4. Ensure any additions are well documented. This means in the documentation as well as in your pull request.
  5. Any pull requests will be tested by Travis CI. All pull requests must build correctly.

If you are unsure about how to do any of the above, feel free to get in touch in the comments of your pull request to ask for help.

Last update: