docs(contributing): fix branch refs and build steps, add PR template

This commit is contained in:
zarzet
2026-07-09 18:54:32 +07:00
parent 0535b266ff
commit 46491c137a
2 changed files with 39 additions and 6 deletions
+27
View File
@@ -0,0 +1,27 @@
## Description
<!-- What does this PR do? Why is it needed? -->
## Related Issues
<!-- Link related issues, e.g. "Fixes #123" -->
## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Refactor (no functional change)
- [ ] Documentation
- [ ] Other (describe below)
## Checklist
- [ ] Code follows project conventions
- [ ] `flutter analyze` and `flutter test` pass
- [ ] `go vet ./...` and `go test ./...` pass in `go_backend/` (if Go code changed)
- [ ] Documentation updated (if needed)
- [ ] Commit messages follow the [conventional commits](https://www.conventionalcommits.org) format
## Screenshots
<!-- For UI changes, add before/after screenshots. Delete this section otherwise. -->
+12 -6
View File
@@ -83,7 +83,7 @@ Translation files are located in `lib/l10n/arb/`.
2. **Add upstream remote**
```bash
git remote add upstream https://github.com/zarzet/SpotiFLAC-Mobile.git
git remote add upstream https://github.com/spotiflacapp/SpotiFLAC-Mobile.git
```
3. **Use FVM (Flutter Version: 3.41.5)**
@@ -101,11 +101,15 @@ Translation files are located in `lib/l10n/arb/`.
dart run build_runner build --delete-conflicting-outputs
```
6. **Set up Go environment (Go Version: 1.25.7)**
6. **Set up Go environment (Go Version: 1.25.8)**
Building the Go backend for Android requires the **Android NDK** (r29 is what CI uses). Make sure `ANDROID_NDK_HOME` points to it and `CGO_ENABLED=1`.
```bash
cd go_backend
mkdir -p ../android/app/libs
go install golang.org/x/mobile/cmd/gomobile@latest
gomobile init
cd go_backend
mkdir -p ../android/app/libs
gomobile bind -target=android -androidapi 24 -o ../android/app/libs/gobackend.aar .
cd ..
```
@@ -273,11 +277,13 @@ chore(deps): update flutter_riverpod to 3.1.0
- [ ] Commit messages follow guidelines
- [ ] PR description is clear and complete
CI runs `flutter analyze`, `flutter test`, `go vet`, and `go test` on every pull request — make sure they pass locally before pushing.
## Questions?
If you have questions, feel free to:
- Open a [Discussion](https://github.com/zarzet/SpotiFLAC-Mobile/discussions)
- Check existing [Issues](https://github.com/zarzet/SpotiFLAC-Mobile/issues)
- Open a [Discussion](https://github.com/spotiflacapp/SpotiFLAC-Mobile/discussions)
- Check existing [Issues](https://github.com/spotiflacapp/SpotiFLAC-Mobile/issues)
Thank you for contributing! 💚