Contributing

Prerequisites

• Make sure you have Node JS installed.

Installing

• In the terminal type npm install to install all required packages
• Ask System Admin for .env variables for all needed credentials

Developing

1. Install with

   git clone https://github.com/coretech/forex-tool
   cd forex-tool
   npm i
   npm run dev

2. Checkout a branch from develop and make your changes in it branch (say, feat-new-stuff). These changes can be adding new features, fixing bugs, adding documentations, or refactoring existing code. Make sure your commit messages reflect your changes. Look at the section below for detailed instructions.

3. Make sure that your branch successfully run without any error or warning. We won't be able to merge your PR if your code doesn't pass.

4. Make sure to periodically merge develop into your branch to avoid conflicts when creating a PR.

Refer to commit messages to see how we structure our commit messages