Contributing

Setup your machine

cleancontacts is written in Go.

Prerequisites:

Clone cleancontacts:

git clone git@github.com:staticdev/cleancontacts.git

Install the dependencies with:

cd cleancontacts
task setup

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

task test

You can create a branch for your changes and try to build from the source as you go:

task build

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

task ci

Before you commit the changes, we also suggest you run:

task fmt

Commit messages should be well formatted, and to make that "standardized", we are using Conventional Commits.

You can follow the documentation on their website.

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