Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create the contributing file #412

Merged
merged 5 commits into from
May 28, 2021
Merged

Create the contributing file #412

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9ad370f
Create the contributing file
rocboronat May 27, 2021
d807984
Merge branch 'master' into rocboronat-contribute
rocboronat May 27, 2021
0cd7de9
Merge branch 'master' into rocboronat-contribute
alorma May 27, 2021
a6430f4
Merge branch 'master' into rocboronat-contribute
Sloy May 28, 2021
002dba4
Merge branch 'master' into rocboronat-contribute
Sloy May 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
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.