CONTRIBUTING.md

Contributing

Development environments

Development environments are defined in flake.nix and automatically activated when direnv is installed and configured.

• Install nix
• Then use nix develop -c $SHELL, or use direnv:
  • Install direnv
  • Setup direnv
  • Install and setup nix-direnv
  • Run direnv allow
• Finally, run just hooks-install

Commits

Commits should follow the Conventional Commits specification and strive to be all lowercase with no trailing period. This is enforced by prek.

Cocogitto is installed by default and can help when writing Conventional Commits using the cog command.

Examples

cog commit feat "add awesome feature"
# Creates the commit: "feat: add awesome feature"
cog commit fix -B "fix a nasty bug" cli
# Creates a breaking commit: "fix(cli)!: fix a nasty bug"

Releases

Release versions should follow the SemVer specification.

• Release tags will be prefixed with v
• Release versions should follow SemVer and not be prefixed with v

Example: git tag -a v1.2.3 -m "Release 1.2.3"

Cocogitto can perform automatic, versioned releases with the above conventions.

Examples

cog bump --dry-run --auto
# Check the next calculated version
cog bump --auto
# Automatically bump the version to the next calculated version
cog bump --major
# Increment the MAJOR version value

Updating from template

To pull in template updates:

just update

Dependency Updates

This project uses Renovate for automated dependency updates. Set the RENOVATE_TOKEN repository secret to a GitHub PAT with repo scope.