Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 1.95 KB

CONTRIBUTING.org

File metadata and controls

61 lines (43 loc) · 1.95 KB
Raw

Contributing

Running tests

Just run:

$ make test

Git validation

In order to ensure that the git log is as maintainable as possible, the git-validation tool is used. You can install this tool by running:

$ go get -u github.com/vbatts/git-validation

If you already have this tool installed, then simply perform:

$ make git-validation

Note that if you don’t have this tool installed the task will do nothing (it will just print a help message). This is done so when running the default make task this doesn’t interrupt it. This task is already called by the default test one.

Shellcheck

This project uses shellcheck in order to validate the code style. In order to run shellcheck, just perform:

$ make shellcheck

Issue reporting

I’m using Github in order to host the code. Thus, in order to report issues you can do it on its issue tracker. A couple of notes on reports:

  • Check that the issue has not already been reported or fixed in master.
  • Try to be concise and precise in your description of the problem.
  • Provide a step by step guide on how to reproduce this problem.
  • Provide the version you are using (the commit SHA, if possible).

Pull requests

  • Write a good commit message.
  • Make sure that tests are passing on your local machine (it will also be checked by the CI system whenever you submit the pull request).
  • Update the changelog.
  • Try to use the same coding conventions as used in this project.
  • Open a pull request with only one subject and a clear title and description. Refrain from submitting pull requests with tons of different unrelated commits.