Skip to content

Commit 4da8b22

Browse files
authored
docs: add information about spotless for code formatting (#2622)
Signed-off-by: James Rich <[email protected]>
1 parent 2daf1ba commit 4da8b22

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Thank you for your interest in contributing to Meshtastic-Android! We welcome co
1414

1515
- Follow the [Kotlin Coding Conventions](https://kotlinlang.org/docs/coding-conventions.html) for Kotlin code.
1616
- Use Android Studio's default formatting settings.
17+
- We use [spotless](https://github.com/diffplug/spotless) for automated code formatting. You can run `./gradlew spotlessApply` to format your code automatically.
18+
- You can also run `./gradlew spotlessInstallGitPrePushHook --no-configuration-cache` to install a pre-push Git hook that will run a `spotlessCheck`.
1719
- Write clear, descriptive variable and function names.
1820
- Add comments where necessary, especially for complex logic.
1921
- Keep methods and classes focused and concise.

0 commit comments

Comments
 (0)