webmail/CONTRIBUTING.md

Contributing to Bulwark Webmail

Bug reports, feature requests, translations and patches are all welcome.

The full guide is in the documentation under Contributing. It covers the development setup, the test suites, translations and right-to-left layouts, code style, and how pull requests are reviewed.

To get a development server running:

git clone https://github.com/bulwarkmail/webmail.git
cd webmail
npm install
cp .env.dev.example .env.local   # built-in mock JMAP server, no mail server needed
npm run dev

Before you open a pull request, run npm run typecheck && npm run lint && npx vitest run. Commit messages follow Conventional Commits (feat:, fix:, docs: and so on).

You can use AI tools for your contributions. The guide's AI-assisted contributions section explains what we expect.

• Questions: ask on Discord.
• Documentation fixes: the docs are Markdown files in the website repository.
• Security vulnerabilities: report them privately to dev@bulwarkmail.org or through a security advisory, never in a public issue.