Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (28 loc) · 1002 Bytes

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 1002 Bytes
Raw

Contributing

Forks and independent improvements are welcome. This repository does not accept pull requests. Bug reports may be submitted through GitHub issues, but maintainers are not obligated to implement or merge proposed changes.

Development

Use Node.js 24 LTS and install the locked dependency tree:

npm ci
cp .env.example .env
npm run dev

Use a temporary DATA_DIR when testing database bootstrap changes. Never commit local databases, photos, backups, credentials, or .env files.

Maintaining a fork

Before publishing changes in your fork, run:

npm run typecheck
npm run lint
npm test
npm run build
npm audit

User-facing text must be translated in every catalog under messages/. Database changes must update the baseline schema and include an explicit, data-preserving upgrade path for existing public installations.

Security reports

Follow SECURITY.md. Do not disclose vulnerabilities in public issues before a fix is available.