Skip to content

Native Android client for Spotify, built with Jetpack Compose

README: downloads and Wrapped now describe the Sync downloaded songs with Spotify setting without promising that Spotify counts the play; a short CONTRIBUTING.md with build, tests, commit style and the rules on extensions, Spotify's protections and the GPL-3.0 license [skip ci]

kota-zo819bba4fe678
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..3f77d982
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,27 @@
+# Contributing to Myspoti
+
+Thanks for helping. Bug reports (with a diagnostic report from Settings), fixes and translations are all welcome.
+
+## Build and test
+
+Requirements: JDK 17+ and the Android SDK (compileSdk 37). The Android project is in `base/`.
+
+```bash
+cd base
+./gradlew assembleDebug
+./gradlew :app:testDebugUnitTest :api-spotify:test
+```
+
+Put your SDK path in `base/local.properties` (`sdk.dir=...`). The live API tests (`:host-cdp:test`) need a desktop Chrome signed in to the Web Player; see the README.
+
+## Changes
+
+- Keep a change focused, and write it like the code around it. Texts in the repository (code, comments, strings in `values/`, docs) are in English; translations go in the matching `values-xx/` folder.
+- Add or update a unit test when you fix a bug or change a rule.
+- Commit messages are one plain sentence in English that says what changes for the user (or what was wrong), not a list of files.
+
+## Rules
+
+- **Extensions API:** an extension call that is accepted today must never become an error. New fields and calls are fine; removing, renaming or tightening an existing one is not.
+- **Spotify:** Myspoti talks to Spotify the way its Web Player does. No contribution may bypass, weaken or work around Spotify's protections (DRM, licences, attestation, rate limits), and none may add a Spotify audio download or decryption.
+- **License:** Myspoti is GPL-3.0. Your contribution is released under the same license. If you reuse this code in another project, keep the notices, credit Myspoti (https://github.com/kota-zo/myspoti) and publish your complete source under GPL-3.0; closing the source or changing the license is a violation.
diff --git a/README.md b/README.md
index 43b13497..a1573b12 100644
--- a/README.md
+++ b/README.md
@@ -114,7 +114,7 @@ Every change is in the [changelog](CHANGELOG.md).
**"Spotify refused to play this"?** Some new or free accounts get refused by Spotify. Settings → **Export a diagnostic report** and send it on [Discord](https://discord.gg/jXKnGVFnGS) or in an [issue](https://github.com/kota-zo/myspoti/issues): it holds the app's recent log (what Spotify answered) and your phone's model, never your password or your login tokens.
-**Do downloads count in my Wrapped?** No. Songs played from a download are not reported to Spotify; they count in Myspoti's own recap only. Streamed songs and music videos count as usual.
+**Do downloads count in my Wrapped?** They always count in Myspoti's own recap. With **Sync downloaded songs with Spotify** (Settings → Playback, on by default), a downloaded song played online also plays muted on Spotify so your other devices see and control it; whether Spotify counts that play is up to Spotify and not guaranteed. Offline, or with the setting off, the file plays only from the phone and nothing is reported. Streamed songs and music videos count as usual.
**What leaves my phone?** Your plays go to Spotify. Lyrics are looked up on lyrics sites, song meanings on Genius, translations on Google Translate, music videos on YouTube, and downloads on the hosts your download-source extension names (shown before you install it). Nothing is sent to the developer.