diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..77881cb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,27 @@ +--- +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: +- Mode: vs AI / puzzles / openings / Bluetooth / LAN + +**Screenshots or logs** (optional) + 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/puzzle_opening_issue.md b/.github/ISSUE_TEMPLATE/puzzle_opening_issue.md new file mode 100644 index 0000000..4e3e502 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/puzzle_opening_issue.md @@ -0,0 +1,10 @@ +--- +name: Puzzle or opening issue +about: Report a wrong puzzle solution or opening line +title: "[Content] " +--- + +- Puzzle or opening name: +- Position (describe or attach a screenshot): +- What the app expects: +- What you think is correct, and why: diff --git a/.github/ISSUE_TEMPLATE/translation_fix.md b/.github/ISSUE_TEMPLATE/translation_fix.md new file mode 100644 index 0000000..5b7babf --- /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..fada55f --- /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` and `./gradlew testDebugUnitTest` pass +- [ ] Tested on a device or emulator (Android version: ) +- [ ] Multiplayer changes tested on two physical devices +- [ ] 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..6f3e152 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,71 @@ +# Contributing to Matewave + +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/Matewave) | Issues and pull requests (needs an account on git.skysparkle.cc) | +| [GitHub](https://github.com/kalarina-bit/Matewave) | Issues and pull requests, if you prefer GitHub | + +Pull requests are reviewed where they were opened; the maintainer keeps both repositories in sync. + +## Ways to help + +- **Report a bug** — use the *Bug report* template. +- **Report a wrong puzzle or opening line** — use the *Puzzle or opening issue* 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): open an issue first and wait for a go-ahead, so your work isn't wasted. + +## Ground rules + +- No ads, analytics, trackers, crash reporters or accounts. +- 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: + +- Bundled or external chess engines such as Stockfish. +- An analysis board, PGN/FEN import or a board editor. +- Two players on one device. +- Online play through servers, invite links or Wi-Fi Direct — multiplayer stays Bluetooth and local network only. +- More radio stations — the built-in jazz radio stays a single ad-free station. +- A light theme or automatic light/dark switching — Matewave is dark only. +- New UI languages (see [Translations](#translations)). + +## Translations + +Matewave is available in exactly six languages: English, Russian, German, Japanese, Lithuanian and Chinese. Fixes to these are welcome; new languages are not accepted. + +- 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 for the other languages 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` and `./gradlew testDebugUnitTest` pass. +5. Changes to multiplayer must be tested on two physical devices. +6. Write short, plain commit messages in English (for example `Fix castling check in LAN games`). +7. 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/Matewave/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 1b6c568..444a7fa 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,10 @@ Requires JDK 17+ and Android Studio with AGP 9.2 support. Nearby multiplayer needs two physical devices — the emulator has no real Bluetooth, and mDNS discovery is often blocked on emulator networks. +## Contributing + +Bug reports, puzzle and opening fixes, translation fixes and pull requests are welcome on [Gitea](https://git.skysparkle.cc/kalarina/Matewave/issues) and [GitHub](https://github.com/kalarina-bit/Matewave/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).