Route Rating Web

Getting Started

This repo uses lerna to manage the dependencies. It is recommend that you read the lerna documentation to gain a better understanding as to how this tools works. We use yarn for our package manager.

Commands

Installing Dependencies

yarn

Building the Projects

yarn build

Testing the Projects

yarn test

Linting the Projects

yarn lint

Formatting the Projects

yarn format

Contributing

We enforce conventional commits in order to allow lerna to automatically version the packages. When making a commit you must format them correctly or you will not be allowed to commit your changes. The steps to contribute are as follows

1. Make your changes
2. Write tests for your changes
3. Format the files
4. Checkout a new branch
5. Commit your changes using the correct commit message formatting
6. Push your changes to the remote repository
7. Create a pull request and ask for a review