Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (25 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

37 lines (25 loc) · 2.92 KB
Raw

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.

What fits

Read What fits in Bulwark before you start on a feature. In short:

  • Bulwark is built for Stalwart. Changes for other JMAP servers are welcome if they cost Stalwart users nothing.
  • Core is for what most people expect from a mail, calendar, contacts and files client. Niche workflows and integrations with other services belong in plugins.
  • Not in core: IMAP or other non-JMAP backends, integrations with other services, Stalwart server administration, and changes to the look that go beyond themes.
  • New behaviour gets one good default. If deployments really need different behaviour, add an admin setting, not a per-user toggle.
  • Features must work in Bulwark Lite, or be hidden there, and UI changes must work at phone width.

Open an issue and agree on the approach before you write a change that is larger than about 500 lines (not counting locales and tests), adds a runtime dependency, or touches sign-in, sessions, the HTML sanitizer, the plugin sandbox, outgoing-request guards or admin routes. Deliver large features as a series of pull requests that can each be reviewed on their own. Pull requests with review feedback unanswered for 30 days are closed.

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.

By contributing, you agree that your contributions are licensed under the terms in LICENSE: AGPL-3.0-only, with the additional permission for app store distribution. The permission is still provisional for older code, but it applies in full to contributions made since 30 September 2026.