Thank you for your interest in contributing to Trellis!
Trellis is an open-source project designed to be the robust backbone for AI Agents and Automation. We value clarity, reliability, and thoughtful design.
-
Clone the repository:
git clone https://github.com/aretw0/trellis.git cd trellis -
Sync dependencies:
go mod tidy
-
Run tests:
make test # or go test ./...
Before submitting a Pull Request, please review our standards:
We follow a context-aware language policy:
- English: For all code (comments, variables), public documentation (
README,examples), and user-facing CLI messages. - Portuguese: For internal engineering documentation (
docs/TECHNICAL.md,docs/PLANNING.md).
See docs/STANDARDS.md for details.
We have a high bar for reliability. All new features must be tested. See docs/TESTING.md to understand our testing strategy and how to use Fixtures.
We use Conventional Commits.
feat: ...for new featuresfix: ...for bug fixesdocs: ...for documentationrefactor: ...for code cleanup without behavior change
- Create a feature branch from
main. - Ensure
make testpasses locally. - Open a PR describing what changed and why.
- If your PR changes behavior, ensure
docs/are updated.
Questions? Discussions? Feel free to open an Issue or start a Discussion on GitHub.