diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 245759fb9..0102a1f7e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1 +1,51 @@ -# Contributing Guidelines +# Auxio contribution guidelines + +## Crashes & Bugs + +Log them in the [Issues](https://github.com/OxygenCobalt/Auxio/issues) tab. + +Please keep in mind when reporting an issue: +- **Has it been reported?** Make sure an issue for the issue is not already there. +- **Has it been already fixed?** Make sure a fix wasn't already added. +- **Is it still relevant in the latest version?** Make sure to test it in the latest version. + +If you do make an issue, Make sure to provide: +- A summary of what you were doing before the bug/crash +- What do you did that caused the bug/crash +- A trace/logcat if possible, the longer the better. + +If you have knowledge of Android/Kotlin in general, you could also go about fixing the bug yourself and opening a [Pull Request](https://github.com/OxygenCobalt/Auxio/pulls). + +## Feature Requests + +These should also be logged in the [Issues](https://github.com/OxygenCobalt/Auxio/issues) tab. + +Please keep in mind when requesting a feature: +- **Has it already been requested?** Make sure request for this feature is not already here. +- **Has it been already added?** Make sure this feature has not already been added in the most recent release. +- **Will it be accepted?** Read the [Accepted Additions and Requests](../info/ADDITIONS.md) in order to see the likelyhood that your request will be accepted. + +If you do make a request, provide the following: +- What kind of addition is this? +- What is it that you want? +- Why do you think it will benefit everyone's usage of the app? + +If you have the knowledge, you can also implement the feature yourself and create a [Pull Request](https://github.com/OxygenCobalt/Auxio/pulls), but its recommended that **you create an issue beforehand to give me a heads up.** + +## Translations + +I still need to setup weblate, so currently you should open a [Pull Request](https://github.com/OxygenCobalt/Auxio/pulls) to add translations to the strings.xml for your specific language. + +## Code Contributions + +If you have knowledge of Android/Kotlin, feel free to to contribute to the project. + +- If you want to help out with an existing bug report, comment on the issue that you want to fix saying that you are going to try your hand at it. +- If you want to add something, its recommended to open up an issue for what you want to change before you start working on it. That way I can determine if the addition will be merged in the first place, and generally gives a heads-up overall. +- Do not bring non-free software into the project, such as Binary Blobs. +- Stick to [F-Droid Contribution Guidelines](https://f-droid.org/wiki/page/Inclusion_Policy) +- Make sure you stick to Auxio's styling with [ktlint](https://github.com/pinterest/ktlint). `ktlintformat` should run on every build. +- Please ***FULLY TEST*** your changes before creating a PR. Untested code will not be merged. +- Java code will **NOT** be accepted. Kotlin only. +- Keep your code up the date with the upstream and continue to maintain it after you create the PR. This makes it less of a hassle to merge. +- Make sure you have read [Accepted Additions and Requests](../info/ADDITIONS.md) before working on your addition. \ No newline at end of file diff --git a/LIBRARIES.md b/LIBRARIES.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/README.md b/README.md index 0d5cff207..736c93c17 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ However, Auxio is also structured to be customizable and extendable, in the case [](assets/shot_queue_port.png) [](assets/shot_notif.png) [](assets/shot_settings_port.png) -[](info/shot_album_alt.png) +[](assets/shot_album_alt.png) ## Features diff --git a/app/build.gradle b/app/build.gradle index cf6b96fd2..f97239a9b 100644 --- a/app/build.gradle +++ b/app/build.gradle @@ -23,6 +23,8 @@ android { buildTypes { debug { + debuggable true + applicationIdSuffix = '.debug' versionNameSuffix = "-DEBUG" } @@ -45,6 +47,10 @@ configurations { ktlint } +afterEvaluate { + preDebugBuild.dependsOn ktlintFormat +} + dependencies { implementation fileTree(dir: "libs", include: ["*.jar"]) diff --git a/app/src/main/java/org/oxycblt/auxio/library/LibraryFragment.kt b/app/src/main/java/org/oxycblt/auxio/library/LibraryFragment.kt index b3e175042..3ab2db59b 100644 --- a/app/src/main/java/org/oxycblt/auxio/library/LibraryFragment.kt +++ b/app/src/main/java/org/oxycblt/auxio/library/LibraryFragment.kt @@ -40,6 +40,7 @@ import org.oxycblt.auxio.ui.setupSongActions * A [Fragment] that shows a custom list of [Genre], [Artist], or [Album] data. Also allows for * search functionality. * TODO: Move search to separate tab? + * FIXME: Leak when navving from search */ class LibraryFragment : Fragment(), SearchView.OnQueryTextListener { diff --git a/info/FAQ.md b/info/FAQ.md index 7d59a504e..8ae3ce5be 100644 --- a/info/FAQ.md +++ b/info/FAQ.md @@ -18,7 +18,7 @@ I still need to set up Weblate, but you can open a [Pull Request](https://github ## Why ExoPlayer? -ExoPlayer is far more flexible than the native MediaPlayer API, allowing Auxio to be extended to sources that aren't just the local files on the phone, while still providing consistent playback behavior across devices and OEMs. +ExoPlayer is far more flexible than the native MediaPlayer API, which allows Auxio to have consistent behavior across devices & OEMs, and also allowing the app to be extended to sources beyond local music files. ## Why is there no black mode? @@ -30,14 +30,10 @@ Custom accents would require some changes to the accent system in the app, which ## Why are accents lighter/less saturated in dark mode? -As per the [Material Guidelines](https://material.io/design/color/dark-theme.html), accents should be less saturated on dark mode to reduce eye strain. +As per the [Material Guidelines](https://material.io/design/color/dark-theme.html), accents should be less saturated on dark mode to reduce eye strain and to make it look better in general. You will be able to set the accent to something less saturated when I implement custom accents. -## Does Auxio have an equalizer? - -No. Don't need it. Will never add it. - ## Why isn't edge-to-edge enabled on versions below Oreo? The APIs for changing system bar colors were only added in API Level 27 (Oreo MR1), meaning that edge-to-edge will not work below that version.