starred/webmail
1
0
Fork 0
mirror of https://github.com/bulwarkmail/webmail.git synced 2026-10-30 16:16:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add contribution scope and issue-first rules to the contributing guide

Browse Source
This commit is contained in:
Linus Rath
2026-10-02 11:05:05 +02:00
parent 410d6b3532
commit 276fe784d2
2 changed files with 33 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/PULL_REQUEST_TEMPLATE.md
+21
View File
@@ -0,0 +1,21 @@
## What and why
<!-- What changes for the user, and why. A few sentences are enough. -->
## Related issues
<!-- "Fixes #123". For a change that needed agreement first, link the issue where the approach was agreed. -->
## Checklist
- [ ] The change fits [What fits in Bulwark](https://bulwarkmail.org/docs/development/contributing#what-fits-in-bulwark) (core, not plugin material)
- [ ] It needed no issue first, or the approach was agreed in the linked issue (over ~500 lines excluding locales and tests, a new runtime dependency, or security-sensitive code: [details](https://bulwarkmail.org/docs/development/contributing#before-you-write-code))
- [ ] `npm run typecheck && npm run lint && npx vitest run` pass, and new logic has tests
- [ ] New user-facing text goes through translations
- [ ] Works in Bulwark Lite, or is hidden there
- [ ] UI changes checked at phone width and in the light and dark theme
- [ ] Documentation updated in the [website repository](https://github.com/bulwarkmail/website/tree/main/docs), or not needed
## Screenshots
<!-- For UI changes: desktop and phone width. -->
CONTRIBUTING.md
+12
View File
@@ -4,6 +4,18 @@ 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.
## What fits
Read [What fits in Bulwark](https://bulwarkmail.org/docs/development/contributing#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:
```bash