Skip to content

Initial list of best practices to follow in our project #1925

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
bogdandrutu merged 3 commits into from
Oct 31, 2020
Merged

Initial list of best practices to follow in our project #1925

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9f36bb5
Initial list of best practices to follow in our project
bogdandrutu Oct 29, 2020
d0470ab
Update CONTRIBUTING.md
bogdandrutu Oct 29, 2020
726ff76
Update CONTRIBUTING.md
bogdandrutu Oct 30, 2020
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
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,15 @@ which uses [google-java-format](https://github.com/google/google-java-format) li

`./gradlew spotless`

### Best practices that we follow

* Avoid exposing publicly any class/method/variable that don't need to be public.
* By default, all arguments/members are treated as non-null. Every argument/member that can be `null` must be annotated with `@Nullable`.
* The project aims to provide a consistent experience across all the public APIs. It is important to ensure consistency (same look and feel) across different public packages.
* Use `final` for public classes everywhere it is possible, this ensures that these classes cannot be extended when the API does not intend to offer that functionality.

If you notice any practice being applied in the project consistently that isn't listed here, please consider a pull request to add it.

### Pre-commit hook
To completely delegate code style formatting to the machine,
you can add [git pre-commit hook](https://git-scm.com/docs/githooks).
Expand Down