Contributing

By participating to this project, you agree to abide our code of conduct.

Setup your machine

hub is written in Go.

Prerequisites are:

Clone hub from source into some path:

git clone git@github.com:leandro-lugaresi/hub.git
cd hub

If you created a fork clone your fork and add my repository as a upstream remote:

git clone git@github.com:{your-name}/hub.git
cd hub
git remote add upstream git@github.com:leandro-lugaresi/hub.git

Install the build and lint dependencies:

$ make setup

A good way of making sure everything is all right is running the test suite:

$ make test

When you are satisfied with the changes, we suggest you run:

$ make ci

Which runs all the linters and tests.

Push your branch to your example fork and open a pull request against the main branch.