Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

37 lines (27 loc) · 1.26 KB
Raw

How to contribute

We'd love to accept your contributions to this App. There are just a few steps you need to follow.

Important

You must point your PR to the develop Branch. Update your branch develop in your local repository before push

Branching

  • fix/ -> Bugs, small fixes like typos.
  • feature/ -> New functionalities.
  • chore/ -> Changes that not affect the production code like update dependencies.
  • refactor/ -> Code refactor.
  • test/ -> Add missing test.

Pull request for review

When you clone this repository a git hook is going to be installed in your local git. The git hooks are:

  • pre-commit.
  • pre-push.

Note

If you are using a Windows maching review the scripts:

Pre-commit

  1. A script runs Ktlint format it is going to format your code before commit.
  2. A script runs all the unit tests to verify that none of the tests are broken.

Pre-push

  1. A script runs all UI test locally.

Warning

YOU MUST HAVE A EMULATOR OR PHYSICAL DEVICE CONNECTED OR RUNNING.

Please correct any failures before requesting a review.