Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 1 KB

CONTRIBUTING.md

File metadata and controls

58 lines (38 loc) · 1 KB

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 [email protected]:leandro-lugaresi/hub.git
cd hub

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

git clone [email protected]:{your-name}/hub.git
cd hub
git remote add upstream [email protected]:leandro-lugaresi/hub.git

Install

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

Test your change

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

$ make ci

Which runs all the linters and tests.

Submit a pull request

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