mirror of
https://github.com/kalarina-bit/Matewave.git
synced 2026-11-22 08:06:09 +00:00
Add contributing guide and issue/PR templates
This commit is contained in:
@@ -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-<lang>/strings.xml` (English is `values/`).
|
||||
- Store listing: `fastlane/metadata/android/<locale>/`.
|
||||
|
||||
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.
|
||||
Reference in New Issue
Block a user