Thanks for your interest in contributing! Golems is open source under Apache 2.0.
git clone https://github.com/EtanHey/golems.git
cd golems
bun install- Fork the repo and create a branch from
master - Write tests first when adding new functionality
- Run tests before pushing:
bun test - Keep commits focused — one logical change per commit, conventional format (
feat:,fix:,docs:) - Open a PR against
master
- Create a PR with a clear description of what and why
- Tests must pass — CI runs automatically
- CodeRabbit reviews every PR automatically:
- Fix CRITICAL/HIGH issues before merge
- MEDIUM issues are judgment calls
- Style-only comments can be skipped with rationale
- PRs are squash-merged
We use a vouching system for new contributors, inspired by the t3-oss community:
- First PR? An existing contributor or maintainer reviews and vouches for you
- Vouched contributors get faster review cycles on subsequent PRs
- No CLA required — your contributions are licensed under Apache 2.0 by submitting them
- Add
Vouched-by: @usernameto your PR description if someone invited you
This project uses AI coding tools extensively. When AI agents contribute code:
- Add
Co-Authored-By: <agent> <[email protected]>to commit messages - AI-generated code goes through the same review process as human code
- No distinction in quality standards — all code must pass tests and review
- TypeScript for all new code
- No
anytypes — use proper interfaces - Tests live next to source files:
foo.tshasfoo.test.ts - Use
@golems/sharedfor Supabase, LLM, and notification utilities
Open an issue with: what you expected, what happened, steps to reproduce, and your environment (OS, Bun version).
By contributing, you agree that your contributions will be licensed under the Apache License, Version 2.0.