Contributing
By participating in this project, you agree to abide our code of conduct.
Set up your machine
golang-cli-template is written in Go.
Prerequisites:
Other things you might need to run the tests:
Clone golang-cli-template anywhere:
git clone git@github.com:thazelart/golang-cli-template.git
cd into the directory and install the dependencies:
make local/deps
Test your change
You can create a branch for your changes and try to build from the source as you go:
make go/build
When you are satisfied with the changes, we suggest you run:
make go/test
Before you commit the changes, we also suggest you run:
make pre-commit
Create a commit
Commit messages should be well formatted, and to make that "standardized", we are using Conventional Commits.
You can follow the documentation on their website.
Submit a pull request
Push your branch to your golang-cli-template fork and open a pull request against the main branch.
Credit
This CONTRIBUTING guideline is very inspired by the goreleaser. Thanks goreleaser.