Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
51 lines (34 loc) · 1.32 KB

DEVELOPMENT.md

File metadata and controls

51 lines (34 loc) · 1.32 KB

Developer Guide

This document describes how to set up a local development environment, run checks, and contribute changes to the project.

💡 All commands below assume a Unix-like environment (macOS or Linux).

1. Environment Setup

Create and activate a virtual environment using uv — a fast Python package manager and virtualenv tool:

uv venv --python 3.12
source .venv/bin/activate

2. Linting and Code Style

This project enforces linting and formatting through pre-commit hooks.

Install and configure:

uv pip install pre-commit
pre-commit install

Install go using homebrew, below example assume on Mac.

brew install go
go env -w GOPROXY=direct
brew install shellcheck

To manually run all linters:

pre-commit run --all-files

Before committing or pushing changes, make sure your local Git and GitHub environments are properly configured. Set your name and email — this is required for commit metadata and for the sign-off hook to work correctly.

git config --global user.name <YOUR NAME>
git config --global user.email <YOUR EMAIL>