Contributing

The short version

Open an issue first, ship a PR with tests, expect a review within a week. Multi-tenancy bugs are subtle; concrete reproductions move twice as fast as long descriptions.

Dev environment

git clone https://github.com/Arcoders/Adonisjs-lasagna-saas-tenancy.git
cd Adonisjs-lasagna-saas-tenancy
npm install
npm run typecheck
npm run test           # unit tests against source
npm run test:integration  # builds + runs integration tests against ./build/

The integration suite runs against real PostgreSQL and Redis. The fastest way to bring those up:

docker compose -f compose.test.yml up -d

Running a single test

The repo uses Japa. Filter by file or test name:

npm run test -- --files tests/unit/services/telemetry_service.spec.ts
npm run test -- --tests "resolves tenant id from header"

Style and tooling

• ESLint config in eslint.config.js (extends @adonisjs/eslint-config).
• Prettier uses @adonisjs/prettier-config.
• No npm scripts for either; run npx eslint / npx prettier directly.

File names and exports

• snake_case files, PascalCase classes, default-exported.
• TypeScript imports use .js extensions (module: NodeNext).
• Public surface lives behind explicit subpath exports; when adding a new entry point, update both exports and typesVersions in package.json.

Tests are mandatory

PRs without tests bounce. The package's invariants; tenant isolation, identifier validation, cache namespacing; are exactly the kind of thing that breaks silently. The doctor command finds breakage in production; tests find it before production.

If you don't know how to write the test, open the PR with a TODO and ask. Reviewers will help.

Filing issues

Reproducible bug reports save hours. The template asks for:

• The package version (package.json version).
• A minimal AdonisJS 7 project showing the bug, or a copyable code snippet against the examples/api reference app.
• The actual vs expected behaviour.

Vague reports ("queue worker doesn't pick up jobs") are hard to action. Concrete reproductions ("when I dispatch InstallTenant from the configure hook, the worker logs 'no handler' for that tenant_id") get fixed in a single round trip.

Roadmap

The current focus areas live on the GitHub project board. Top-level themes:

• v2.0.0 stable; finalise APIs, ship the public site, community channels.
• Dashboard package; @adonisjs-lasagna/dashboard consuming the OpenAPI spec, Inertia + Vue.
• Starter kit; create-lasagna-saas wiring Lasagna + Auth + Stripe.

Code of conduct

Be the kind of contributor you'd want to work with. Respect time zones, assume good faith, default to written explanations over short replies. Reviews are about the code, not the author.

License

MIT. Contributing means agreeing your contributions ship under MIT.