Contributing to SilentSuite
Thank you for your interest in contributing to SilentSuite. This guide will help you get set up and start contributing.
| Guide | Description |
|---|---|
| Development Setup | Get a local dev environment running |
| Architecture Overview | How the codebase is organized |
| Code Conventions | Style guide and patterns we follow |
| Testing | How to run and write tests |
| Pull Request Guide | How to submit changes |
| Translation Guide | Help translate the web app safely and consistently |
Before You Start
If this is your first contribution, start with an issue labeled good first issue. These are intentionally small and should have exact files and acceptance criteria. If anything is unclear, ask in the issue before opening a PR.
- Do not paste passwords, API keys, recovery phrases,
.envvalues, or private calendar/contact/task content into issues, PRs, screenshots, or logs. - Redact sensitive values before posting debug output.
- Read the Development Setup guide to get the project running locally.
- Check existing issues on GitHub for something to work on, or open a new issue to discuss your idea before writing code.
- Follow the Pull Request Guide when submitting changes.
- For translations, read the Translation Guide before adding or updating locale files.
First PR Checklist
- Keep the PR focused on one issue only.
- Mention the issue number in the PR description.
- Include screenshots for visual or docs changes when helpful.
- Say what you tested, or state that the change is docs-only.
Code of Conduct
Be respectful, constructive, and inclusive. We're building privacy tools for everyone.
License
By contributing to SilentSuite, you agree that your contributions will be licensed under the license that applies to the component you are modifying: AGPL-3.0-only for the server, web, self-host, and documentation components; GPL-3.0-only for the Android sync adapter; and the terms in bridge/LICENSE (GNU AGPL v3 or later) for the Bridge. Check the LICENSE file in the subtree you are contributing to.