From 9dda504172aa506f5cc24da4fe8c3b0eede0d311 Mon Sep 17 00:00:00 2001 From: kalarina Date: Sun, 11 Oct 2026 14:01:49 +0000 Subject: [PATCH] Add contributing guide and issue/PR templates --- .github/ISSUE_TEMPLATE/bug_report.md | 28 +++++++ .../ISSUE_TEMPLATE/doh_server_or_blocklist.md | 14 ++++ .github/ISSUE_TEMPLATE/feature_request.md | 18 +++++ .github/ISSUE_TEMPLATE/translation_fix.md | 12 +++ .github/PULL_REQUEST_TEMPLATE.md | 17 +++++ CONTRIBUTING.md | 74 +++++++++++++++++++ README.md | 4 + 7 files changed, 167 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/doh_server_or_blocklist.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/translation_fix.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..3114db9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,28 @@ +--- +name: Bug report +about: Something doesn't work as expected +title: "[Bug] " +--- + +**What happened** + + +**Steps to reproduce** + +1. +2. +3. + +**What you expected** + + +**Environment** + +- App version: +- Installed from: Gitea / GitHub / F-Droid +- Device and Android version: +- DoH server in use: +- Network: Wi-Fi / mobile data + +**Screenshots or logs** (optional — please remove domains you don't want to share) + diff --git a/.github/ISSUE_TEMPLATE/doh_server_or_blocklist.md b/.github/ISSUE_TEMPLATE/doh_server_or_blocklist.md new file mode 100644 index 0000000..140782f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/doh_server_or_blocklist.md @@ -0,0 +1,14 @@ +--- +name: DoH server or blocklist +about: Suggest a DoH server or blocklist preset +title: "[Preset] " +--- + +- Type: DoH server / blocklist +- Name: +- URL: +- Homepage or documentation: +- Privacy policy (DoH servers) or license (blocklists): + +- [ ] DoH server: public and supports RFC 8484 +- [ ] Blocklist: public and actively maintained diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..925c384 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,18 @@ +--- +name: Feature request +about: Suggest an idea that fits the app +title: "[Feature] " +--- + + + +**What problem does this solve** + + +**Proposed solution** + + +**Alternatives you considered** + + +- [ ] I'd like to implement this myself diff --git a/.github/ISSUE_TEMPLATE/translation_fix.md b/.github/ISSUE_TEMPLATE/translation_fix.md new file mode 100644 index 0000000..239a75f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/translation_fix.md @@ -0,0 +1,12 @@ +--- +name: Translation fix +about: Report a wrong or awkward translation +title: "[Translation] " +--- + + + +- Language: +- Screen or place in the app: +- Current text: +- Suggested text: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..8754706 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,17 @@ +## What does this change + + +## Related issue + +Closes # + +## Checklist + +- [ ] Discussed in an issue first (not needed for small fixes) +- [ ] `./gradlew assembleDebug` builds +- [ ] Tested on a device or emulator (Android version: ) +- [ ] DNS queries only go to the selected DoH server +- [ ] No ads, analytics, trackers or Google Play Services / Firebase dependencies +- [ ] New strings added to `values/strings.xml` (missing translations noted below) +- [ ] Screenshots added for UI changes +- [ ] I agree that my contribution is licensed under GPL-3.0-or-later diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5c03714 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,74 @@ +# Contributing to SparkleDNS + +Thanks for wanting to help! This guide explains where to contribute, what fits the project and how to send changes. + +## Where to contribute + +| Where | What you can do | +|---|---| +| [Gitea](https://git.skysparkle.cc/kalarina/Sparkledns) — main repository | Issues and pull requests (needs an account on git.skysparkle.cc) | +| [GitHub](https://github.com/kalarina-bit/Sparkledns) — copy | Issues and pull requests, if you prefer GitHub | + +Pull requests opened on GitHub are reviewed there and then merged into the main repository by the maintainer. + +## Ways to help + +- **Report a bug** — use the *Bug report* template. +- **Suggest a DoH server or blocklist** — use the *DoH server or blocklist* template. +- **Suggest a feature** — use the *Feature request* template; check [Out of scope](#out-of-scope) first. +- **Fix a translation** — use the *Translation fix* template or send a pull request. +- **Write code** — see [Pull requests](#pull-requests). + +## Before you start + +- **Small changes** (typos, obvious bugs, translation fixes): send a pull request directly. +- **Anything bigger** (new features, UI changes, new dependencies, new languages): open an issue first and wait for a go-ahead, so your work isn't wasted. + +## Ground rules + +- No ads, analytics, telemetry, trackers or accounts. +- DNS queries may only go to the DoH server the user selected — never anywhere else. +- No Google Play Services, Firebase or other proprietary libraries — the app must stay buildable for F-Droid. +- New dependencies must be open source and justified in the pull request. +- Be respectful in issues and reviews. + +## Out of scope + +These will not be accepted: + +- Changing the default DoH server. +- Logging, uploading or sharing users' DNS queries. +- Features that require Google Play Services or a proprietary SDK. + +## DoH servers and blocklists + +- **DoH servers** must be public, support RFC 8484 and publish a privacy policy. +- **Blocklists** must be public, actively maintained and licensed for this kind of use. + +Include links to the server's documentation or the list's homepage in the request. + +## Translations + +SparkleDNS is currently available in English and Russian. Fixes are welcome; for a new language, open an issue first. + +- App strings: `app/src/main/res/values-/strings.xml` (English is `values/`). +- Store listing: `fastlane/metadata/android//`. + +If your code adds new strings, add them to `values/strings.xml`. Translations are welcome but not required — mention missing ones in the pull request. + +## Pull requests + +1. Fork the repository and create a branch from `main`. +2. Keep one topic per pull request. +3. Follow the existing Kotlin and Jetpack Compose style; keep comments short and in English; don't reformat unrelated code. +4. Make sure `./gradlew assembleDebug` builds, and test on a device or emulator. +5. Write short, plain commit messages in English (for example `Fix tunnel restart after server switch`). +6. Add screenshots for UI changes. + +## Security + +Please don't report security issues in public issues. Use [private vulnerability reporting on GitHub](https://github.com/kalarina-bit/Sparkledns/security/advisories/new). + +## License + +By contributing, you agree that your contribution is licensed under the [GNU General Public License v3.0 or later](LICENSE), the same as the rest of the project. diff --git a/README.md b/README.md index b430ee8..c8f9317 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,10 @@ Requires JDK 17+ and Android SDK 36. 2. Add `fastlane/metadata/android//changelogs/.txt`. 3. Tag the commit as `v` (for example `v1.0.6`) — F-Droid detects new releases from these tags. +## Contributing + +Bug reports, DoH server and blocklist suggestions, translation fixes and pull requests are welcome on [Gitea](https://git.skysparkle.cc/kalarina/Sparkledns/issues) and [GitHub](https://github.com/kalarina-bit/Sparkledns/issues). Please read [CONTRIBUTING.md](CONTRIBUTING.md) first — it explains what fits the project and how to send changes. + ## License [GNU General Public License v3.0 or later](LICENSE) (GPL-3.0-or-later).