Skip to content

Latest commit

 

History

History
11 lines (7 loc) · 953 Bytes

CONTRIBUTING.MD

File metadata and controls

11 lines (7 loc) · 953 Bytes

Epoxy is an Open Source Project

Pull requests are welcome! We'd love help improving this library.

We have a code style setting for the project (checkstyle for Java, ktlint for Kotlin). Please run Reformat Code in Android Studio (or Intellij) on changed files before pushing them. Alternatively for Kotlin you can use ktlint tasks: check Kotlin code formatting with./gradlew ktlint and reformat all Kotlin code with ./gradlew ktlintformat.

Also, run ./gradlew check locally to make sure that style checks and tests pass.

If you update the model annotation processor you may find the UpdateProcessorTestResults.kt script very useful for updating the existing tests with your changes. (run it with kscript)

  • Run ./gradlew testDebug first to get test failures, then run kscript UpdateProcessorTestResources.kt to updates sources
  • You may have to repeat this cycle several times for all tests to be updated.