mirror of
https://github.com/bulwarkmail/webmail.git
synced 2026-11-02 08:15:55 +00:00
22 lines
1.2 KiB
Markdown
22 lines
1.2 KiB
Markdown
# Contributing to Bulwark Webmail
|
|
|
|
Bug reports, feature requests, translations and patches are all welcome.
|
|
|
|
The full guide is in the documentation under [Contributing](https://bulwarkmail.org/docs/development/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:
|
|
|
|
```bash
|
|
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](https://www.conventionalcommits.org/) (`feat:`, `fix:`, `docs:` and so on).
|
|
|
|
- Questions: ask on [Discord](https://discord.gg/tYCujymGrT).
|
|
- Documentation fixes: the docs are Markdown files in the [website repository](https://github.com/bulwarkmail/website/tree/main/docs).
|
|
- Security vulnerabilities: report them privately to [dev@bulwarkmail.org](mailto:dev@bulwarkmail.org) or through a [security advisory](https://github.com/bulwarkmail/webmail/security/advisories/new), never in a public issue.
|