Skip to content

Commit

Permalink
Create the contributing file (#412)
Browse files Browse the repository at this point in the history
Co-authored-by: Bernat Borrás Paronella <[email protected]>
  • Loading branch information
rocboronat and alorma authored May 28, 2021
1 parent df24776 commit ab90abc
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Contributing to Barista

Thanks a lot for taking your time to contribute ☕

These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

## Formatting
We use our company's IntelliJ code style for the project, which is very similar to the official Kotlin Android code style. When submitting code please make sure you use the proper format. You can install the code style into Android Studio by running the script in `./config/androidstudio/install-codestyle.sh`. Then restart Android Studio and pick the "BaristaAndroid" schema in preferences.

## Prefer Java-written test classes
As most parts of Barista are Java-compatible, please do write Java tests when possible. Writing them in Kotlin might lead to using Kotlin-only shortcuts, breaking the Java compatibility Barista aims for.

0 comments on commit ab90abc

Please sign in to comment.