re-sputnik/CONTRIBUTING.md
Andrevich 6ea14e9c7c Update docs: system requirements and clarify privacy
- Add OpenWrt 23.05+ requirement to all README files
- Expand privacy statement to clarify no telemetry/analytics and data only goes to router, provided URLs, and official package sources
- Update smoke check command in CONTRIBUTING and all READMEs to include pytest: `python -m compileall -q src && pytest -q`
- Minor formatting improvements
2026-07-01 17:23:03 +04:00

35 lines
1.4 KiB
Markdown

# Contributing to Re:Sputnik
Thanks for your interest in improving Re:Sputnik. It is free software under the
**GNU GPL v3.0** (see [`LICENSE`](LICENSE)).
## Developer Certificate of Origin (DCO)
Contributions are accepted under the **Developer Certificate of Origin 1.1**
(<https://developercertificate.org/>). By signing off on a commit you certify
that you wrote the change (or have the right to submit it) and agree it is
contributed under the project's license.
Sign off every commit by adding a line to the message:
```
Signed-off-by: Your Name <your.email@example.com>
```
`git commit -s` adds this automatically. The name/email must be real.
### Why a DCO (and why it matters here)
The author is the sole copyright holder and may offer the same code under
separate terms as well — for example a custom build for a partner
(dual-licensing). The DCO keeps that possible: by contributing under it you
grant the rights needed for the project to be distributed under the GPLv3 **and**
relicensed by the copyright holder, without a separate copyright-assignment form.
Your contribution always remains available to everyone under the GPLv3.
## Practical notes
- Keep changes focused; match the surrounding code style.
- Any new or changed user-facing `_()` string must update the translation
catalogs in the same change (`src/re_sputnik/locale/*/LC_MESSAGES`).
- Run the smoke checks before opening a PR: `python -m compileall -q src && pytest -q`.