Contributing
How to set up the workspace, run the checks, and open a PR
Thanks for considering a contribution to VernLLM! This page covers workspace setup, expectations for tests, and the pre-PR checklist.
Setup
Fork the repo and branch off main, then install the workspace:
pnpm installTests
Add or update tests alongside any change to packages/vern-llm:
tests/unit/for isolated behaviortests/integration/for cross-cutting workflows
No real API calls are made anywhere in the suite; everything runs against fakes and mocks. See Development for the full test layout.
Before opening a PR
Run these locally, they match CI exactly (.github/workflows/lint.yml, typecheck.yml, test.yml):
pnpm run lint
pnpm run typecheck
pnpm run typecheck:test
pnpm run testChangesets
Record your change with:
pnpm run changesetThis drives versioned release notes. Releases themselves are automated through .github/workflows/release.yml, so there are no manual version bumps or publishing steps.
Code of Conduct
Participation in this project is governed by our Code of Conduct.
Security issues
Please don't open a public issue for a security vulnerability. See Security for how to report one privately.