How to Contribute¶
Set up¶
Follow Install, then:
go build ./...
go vet ./...
go run ./tools/uicheck # template lines that skip the shared styles; keep it at zero
tools/sampledata fills an empty database with three years of sample data for a furniture manufacturer. Its doc comment explains how to run it.
Making a change¶
- Read Architecture, and
CLAUDE.mdfor the area you're changing. - Put new code in the file of the area it belongs to.
- Add schema changes to the end of
schema.sql, written so they can run again. Don't edit earlier statements. - Add translations of new text to every
locales/*.jsonfile. - If you change the API, run
go run ./tools/apidocsand commit the updated reference. - Keep commits focused, with a short summary line in the imperative mood.
Adding a page or a module¶
CLAUDE.md has the checklist under "Adding a new page": routes and guards, page_visibility, permissions, navbar link, approvals, tags and the package's Paths.