Skip to content

docs: add information about spotless for code formatting #2622

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

Merged
merged 4 commits into from
Aug 2, 2025
Merged

docs: add information about spotless for code formatting #2622

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
aeca97e
docs: add information about spotless for code formatting
jamesarich Aug 2, 2025
86e2124
docs: update Spotless Git hook command
jamesarich Aug 2, 2025
ce2c7f9
Merge branch 'main' into docs/spotless
jamesarich Aug 2, 2025
004d2d7
Merge branch 'main' into docs/spotless
jamesarich Aug 2, 2025
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
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Thank you for your interest in contributing to Meshtastic-Android! We welcome co

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