Nicholai f554f4e38c ci: add branch protection, CI workflow, and PR template

- husky pre-commit hook blocks direct commits to main
- github actions CI runs lint + build on PRs
- PR template and CONTRIBUTING.md for workflow docs

2026-01-24 14:23:14 -07:00

948 B

Executable File

Raw Blame History

contributing

local setup

git clone git@github.com:High-Performance-Structures/compass.git
cd compass
bun install
bun dev

branching

branch off main using the format <username>/<feature>:

git checkout -b nicholai/add-gantt-zoom

direct commits to main are blocked by a pre-commit hook.

commits

use conventional commits:

type(scope): subject

types: feat, fix, docs, style, refactor, perf, test, build, ci, chore
subject: imperative mood, 50 chars max
body: 72 chars max width, explain why not what

pull requests

push your branch and open a PR against main
CI runs lint + build automatically
both checks must pass before merge
PRs are squash-and-merged (single clean commit on main)

the PR template will guide you on what to include.

deployment

deployment to cloudflare workers happens manually via bun deploy. this is separate from the PR/merge workflow.

948 B Executable File Raw Blame History