Contributing
Start with a local Docker stack unless your change specifically targets native development.
Local setup
git clone https://github.com/sumanbasuli/lime.git
cd lime
cp .env.example .env
make start-all
Required checks
- Run
make buildbefore opening a release-facing PR. - Run focused Go or frontend tests for the code you changed.
- Keep database migrations forward-only.
- Mirror schema changes in both Shopkeeper migrations and the dashboard Drizzle schema.
- Update docs for every user-facing change.
Pull request expectations
Explain the user impact, data migration impact, and verification. If a change affects large scans or report generation, include before/after notes for first-load latency and export startup behavior.