Contributing

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

Set up your machine

sgpt is written in Go.

Prerequisites:

Clone sgpt anywhere:

git clone git@github.com:tbckr/sgpt.git

cd into the directory and allow the direnv to load the environment:

direnv allow

This will install all the necessary dependencies for the project via nix flakes.

A good way to make sure everything else is okay is to run 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 sgpt fork and open a pull request against the main branch.