Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (33 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 1.12 KB

Contributing

This documentation will help you contribute to this codebase.

Setup

Install taskfile via your preferred method.

mkdir -p ~/.local/bin && sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b ~/.local/bin
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc && source ~/.bashrc

Confirm task installation

task --version

View Tasks

task --list

Development Setup

Run the setup task to configure your development environment:

task setup

This will:

  • Install MkDocs and required plugins
  • Configure Git hooks for automatic changelog generation
  • Set up pre-commit hooks that follow conventional commits

Important: Git Hooks

This project uses Git hooks to automatically generate changelog entries from conventional commits. The setup task above configures this automatically, but if you need to set it up manually:

task setup:hooks

Make sure to follow Conventional Commits specification in your commit messages for proper changelog generation.