Release 0.3.0

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,96 @@
+name: Bug report
+description: Create a bug report to help us improve
+labels: [bug]
+body:
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Checklist
+      options:
+        - label: I am able to reproduce the bug with the [latest version](https://github.com/z-huang/music/releases/latest).
+          required: true
+        - label: I've checked that there is no issue about this bug.
+          required: true
+        - label: This issue contains only one bug.
+          required: true
+        - label: The title of this issue accurately describes the bug.
+          required: true
+
+  - type: textarea
+    id: reproduce-steps
+    attributes:
+      label: Steps to reproduce the bug
+      description: What did you do for the bug to show up?
+      placeholder: |
+        Example:
+          1. Go to '...'
+          2. Click on '....'
+          3. Scroll down to '....'
+          4. See error
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected behavior
+      placeholder: |
+        Example:
+          "This should happen..."
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual-behavior
+    attributes:
+      label: Actual behavior
+      placeholder: |
+        Example:
+          "This happened instead..."
+    validations:
+      required: true
+
+  - type: textarea
+    id: sreen-media
+    attributes:
+      label: Screenshots/Screen recordings
+      description: |
+        A picture or video helps us understand the bug more.
+
+        You can upload them directly in the text box.
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Logs
+      description: |
+        If your bug includes a crash, please use `adb logcat` or other ways to provide logs.
+  
+  - type: input
+    id: music-version
+    attributes:
+      label: Music version
+      description: |
+        You can find your Music version in **Settings**.
+      placeholder: |
+        Example: "0.2.1-beta"
+    validations:
+      required: true
+
+  - type: input
+    id: android-version
+    attributes:
+      label: Android version
+      description: |
+        You can find this somewhere in your Android settings.
+      placeholder: |
+        Example: "Android 12"
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional-information
+    attributes:
+      label: Additional information
+      placeholder: |
+        Additional details and attachments.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,39 @@
+name: Feature request
+description: Suggest an idea for Music
+labels: [enhancement]
+body:
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Checklist
+      options:
+        - label: I've checked that there is no other issue about this feature request.
+          required: true
+        - label: This issue contains only one feature request.
+          required: true
+        - label: The title of this issue accurately describes the feature request.
+          required: true
+
+  - type: textarea
+    id: feature-description
+    attributes:
+      label: Feature description
+      description: What feature you want the app to have? Provide detailed description about what it should look like or where it should be added.
+    validations:
+      required: true
+
+  - type: textarea
+    id: why-is-the-feature-requested
+    attributes:
+      label: Why do you want this feature?
+      description: Describe the problem or limitation that motivates you to want this feature to be added.
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional-information
+    attributes:
+      label: Additional information
+      description: Add any other context or screenshots about the feature request here.
+      placeholder: |
+        Additional details and attachments.

README.md

@@ -1,6 +1,6 @@
 # Music
 
-![Icon](app/src/main/res/mipmap-hdpi/ic_launcher_round.png)
+<img src="https://raw.githubusercontent.com/z-huang/music/dev/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png" height="72">
 
 Make your own music library with any song on YouTube/YouTube Music.  
 No ads, free, and simple.
@@ -11,19 +11,30 @@ No ads, free, and simple.
 [![License](https://img.shields.io/github/license/z-huang/music)](https://www.gnu.org/licenses/gpl-3.0)
 [![Downloads](https://img.shields.io/github/downloads/z-huang/music/total)](https://github.com/z-huang/music/releases)
 
-> **Note:** The project is currently in an unstable stage. If you encounter bugs, please report by opening an issue.
+> **Note 1:** The project is currently in an unstable stage, so there should be many bugs. If you encounter one, please report by opening an issue.
+
+> **Note 2:** The name of this app is temporary. It will be changed in the future.
 
 ## Description
 
-Music uses [NewPipe Extractor](https://github.com/TeamNewPipe/NewPipeExtractor) to retrieve information and stream data from YouTube/YouTube Music. It's a music player as well, so you can create your own playlists and organize your songs by the artists you create. The aim of Music is to enable everyone to listen to music at no cost by an easy-to-use, practical and ad-free application.
+With this app, you're like getting a free music streaming service. You can listen to music from YouTube/YouTube Music and build your own library. What's more, songs can be downloaded for offline playback. The metadata of songs and artists are fully editable. You can also create playlists to organize your songs. The aim of _Music_ is to enable everyone to listen to music at no cost by an easy-to-use, practical and ad-free application.
+
+The ability to retrieve information and stream data from YouTube/YouTube Music is provided by [NewPipe Extractor](https://github.com/TeamNewPipe/NewPipeExtractor).
 
 ## Features
 
 ### YouTube
 
 - No ads
-- Search songs, videos, playlists and channels from YouTube/YouTube Music
-- auto load more songs when playing the last 5 songs in queues from YouTube
+- Search songs, albums, videos, playlists and channels from YouTube/YouTube Music
+- Auto load more songs when playing the last 5 songs in queues from YouTube
+
+### Library
+
+- Play and save songs from YouTube/YouTube Music
+- Download music for offline playback
+- Edit song and artist metadata
+- Create playlists in local database
 
 ### Player
 
@@ -34,27 +45,54 @@ Music uses [NewPipe Extractor](https://github.com/TeamNewPipe/NewPipeExtractor)
 - Repeat/shuffle mode
 - Edit now-playing queue
 
-### Library
+## Screenshots
 
-- Play and save songs from YouTube/YouTube Music
-- Download music for offline playback
-- Edit song name and song artist
-- Create playlists in local database
-
-# Screenshots
 <p float="left">
-  <img src="https://raw.githubusercontent.com/z-huang/music/master/screenshots/main.jpg" width="170" />
-  <img src="https://raw.githubusercontent.com/z-huang/music/master/screenshots/artists.jpg" width="170" />
-  <img src="https://raw.githubusercontent.com/z-huang/music/master/screenshots/playlists.jpg" width="170" />
-  <img src="https://raw.githubusercontent.com/z-huang/music/master/screenshots/explore.jpg" width="170" />
+  <img src="https://raw.githubusercontent.com/z-huang/music/dev/screenshots/main.jpg" width="170" />
+  <img src="https://raw.githubusercontent.com/z-huang/music/dev/screenshots/playlists.jpg" width="170" />
+  <img src="https://raw.githubusercontent.com/z-huang/music/dev/screenshots/player.jpg" width="170" />
+  <img src="https://raw.githubusercontent.com/z-huang/music/dev/screenshots/now_playing.jpg" width="170" />
 </p>
 <p float="left">
-  <img src="https://raw.githubusercontent.com/z-huang/music/master/screenshots/player.jpg" width="170" />
-  <img src="https://raw.githubusercontent.com/z-huang/music/master/screenshots/notification.jpg" width="170" />
-  <img src="https://raw.githubusercontent.com/z-huang/music/master/screenshots/now playing queue.jpg" width="170" />
+  <img src="https://raw.githubusercontent.com/z-huang/music/dev/screenshots/search.jpg" width="170" />
+  <img src="https://raw.githubusercontent.com/z-huang/music/dev/screenshots/search results.jpg" width="170" />
+  <img src="https://raw.githubusercontent.com/z-huang/music/dev/screenshots/settings.jpg" width="170" />
 </p>
-<p float="left">
-  <img src="https://raw.githubusercontent.com/z-huang/music/master/screenshots/search.jpg" width="170" />
-  <img src="https://raw.githubusercontent.com/z-huang/music/master/screenshots/search results.jpg" width="170" />
-  <img src="https://raw.githubusercontent.com/z-huang/music/master/screenshots/settings.jpg" width="170" />
-</p>
+
+## Roadmap
+
+The overall plan for this project at current stage:
+1. Improve user interface
+2. Modify [NewPipe Extractor](https://github.com/TeamNewPipe/NewPipeExtractor) to support more album and artist information and audio normalization
+
+## Installation
+
+You can install _Music_ using the following methods:
+
+1. Download the APK file from [GitHub Releases](https://github.com/z-huang/music/releases).
+2. Add [IzzyOnDroid](https://apt.izzysoft.de/fdroid/index/apk/com.zionhuang.music) to your F-Droid repos following the [instruction](https://apt.izzysoft.de/fdroid/index/info), and you can search for this app and receive updates.
+3. To get a dev build, go to [GitHub Action](https://github.com/z-huang/music/actions) and download the APK artifact of any workflow.
+4. Clone this repository and build a debug APK.
+
+How to get updates?
+
+1. If you install from [GitHub Releases](https://github.com/z-huang/music/releases), the app already has a built-in updater.
+2. If you install from method 2, you can check for updates using the F-Droid application.
+3. Or else, visit [GitHub](https://github.com/z-huang/music) and checkout the releases, issues, PRs, or anything new.
+
+## Contribution
+
+### Contributing Translations
+
+#### App
+
+1. Have a fork of this project.
+2. If you have Android Studio, right click on the `app/src/main/res/values` folder, select "New"->"Values Resource File". Input `strings.xml` as file name. Select "Locale", click ">>", choose your language and region, and click "OK".
+3. If not, create a folder named `values-<language code>-r<region code>` under `app/src/main/res`. Copy `app/src/main/res/values/strings.xml` to the created folder.
+4. Replace each English string with the equivalent translation. Note that lines with `translatable="false"` should be ignored.
+5. (Recommended) Build the app to see if something is wrong.
+6. Make a pull request with your changes. If you do step 5, the process of accepting your PR will be faster.
+
+#### Fastlane (App Description and Changelogs)
+
+Follow the [fastlane instruction](https://gitlab.com/-/snippets/1895688) to add your language and create a pull request.