CONTRIBUTING.md

Contributing

Table of Contents

• Table of Contents
• Setup
  • Pre-requirements
  • Install Node
  • Install JS Dependencies
  • Install Ktlint to IDE
• Running the project

Setup

Pre-requirements

For the javascript runtime, we recommend Node.js.

We strongly suggest you to use NVM (Node Version Manager) and also doing this configuration.

To ensure compatibility with Android Gradle plugin, it is mandatory to use Android Studio Flamingo or any subsequent version.

We use yarn for dependency management, install instructions are available at https://classic.yarnpkg.com/lang/en/.

Install Node

$ nvm install
$ nvm use

Every time you use the repo you will need to use nvm use in your terminal to commit

Install JS Dependencies

$ yarn install

This will install husky pre-commit, pre-push and msg-commit hooks.

Install Ktlint to IDE

To ensure code quality, the project utilizes kotlinter for linting. The linting process is automatically triggered through commit and push hooks. However, you can also perform manual linting by running the commands yarn lint and yarn lint-fix.

For a seamless integration with Android Studio and to conveniently view and fix linting errors within the IDE, we highly recommend installing the ktlint-intellij-plugin. This plugin allows you to directly display and handle linting errors from within Android Studio.

Pro Tip: use a hotkey to make Android Studio format your file for you. You can choose your hotkey on File > Settings > Keymap > Main Menu > Code > Reformat Code & Reformat File

Running the project

To run the project, open it in the IDE, Android Studio, and execute it.