Skip to content
This repository has been archived by the owner on Jul 6, 2024. It is now read-only.

Coding and PR guide

George Lim edited this page Aug 18, 2020 · 1 revision

Overall, there is no strict coding style for this project. Please exercise your best judgement when coding.

Some guidelines

  1. Add comments to your code, especially if the logic is not clear. It doesn't have to be super long, a brief description will do
  2. Use lambdas as completion handlers now that we have Java 8 features enabled (Android studio should suggest it you if you do it the old way)
  3. Every PR should be made under the assumption that they are complete features or fixes (within reason). Please do not try to merge code that looks or feels incomplete.
  4. If you are writing a feature, prefix your branch with feature/. If you are writing a bug fix, prefix your branch with fix/.
  5. If you are writing a feature that cannot be tested without additional temporary code, please make a separate branch for testing purposes and mention the testing branch in the PR description. For example, create a test/some-feature branch to test code for your feature/some-feature PR.
Clone this wiki locally