Skip to content

Latest commit

 

History

History
39 lines (25 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

39 lines (25 loc) · 2.52 KB
Raw

Contributing

Technical Debt

Please be sure to consider how heavily your contribution impacts the maintainability of the project long term, sometimes less is more.

Contributor Checklist

Please make sure that you've considered the following before you submit your Pull Requests as ready for merging:

  • Your code is written in Kotlin and follows the Kotlin Coding Conventions and Android Kotlin Style Guide. If Java is used, please explain in your pull request why Java is required.
  • You have run code linters to make sure that the code is readable.
  • You have read through existing/merged pull requests and open/closed issues to make sure that this contribution is required and isn't a duplicate.
  • You commented adequately your code to make it understandable for other developers.

Legal Agreements

You acknowledge that, if applicable, submitting and subsequent acceptance of any pull request you, the code contributor of the pull request, agree and acknowledge that the code will be licensed under AGPL.

In case you are unable to follow any of the above, please include an explanation in your pull request

Tips

Submodule

Certain assets are provided by the Stash repo (https://github.com/stashapp/stash) which is included as a submodule. Make sure to run git submodule update --init --recursive --remote after cloning this repo to get the latest version of the submodule.

If you get compile errors such as java.nio.file.NoSuchFileException: .../StashAppAndroidTV/app/src/main/res/mipmap-nodpi/stash_logo.png, you need to update the submodule (or the paths in stashapp/stash have changed!).

Creating an object filter

  1. Copy the text of data class for the filter (e.g. app/build/generated/source/apollo/app/com/github/damontecres/stashapp/api/type/SceneMarkerFilterType.kt)
  2. Apply a find-replace a. Find: public val (\w+): Optional<(\w+)\?> = Optional.Absent, b. Replace: $1 = Optional.presentIfNotNull(convert$2(filter["$1"])),
  3. Copy the results to the constructor of the filter class

Image loading

This project uses Glide for image loading. However, developers should use the StashGlide class which handles setting some defaults related to caching.

For example: Glide.with(context).load(url) should be StashGlide.with(context, url)