Contribution Guide

Welcome!

Hi! Thank you for taking your precious time to contribute to War Brokers Projects! We hope you have a pleasant experience working with us <3

How is the project organized?

The War Brokers Projects monorepo is managed using the following technologies:

turborepo
- used to orchestrate everything
- config: turbo.json
yarn workspace

Online Infrastructure

Setting up

⚠️ WAIT! ⚠️

If you are using Windows OS, make sure to run all commands in git bash which you can download here.

Install the following
- git
- vscode
- NodeJS
- yarn
Fork this repository
git clone the forked repository to your computer
Open cloned repository with vscode
- install recommended extensions (a toast should show up on the bottom right corner of the window)
Install dependencies
```
yarn install
```
Initialize Git Hooks
- this is used to lint your commit messages so they follow Conventional Commits
```
yarn prepare
```
read the README.md files of projects you would like to work on. Projects are located in apps and libs directory. You can run package.json scripts in the project directory like so:
```
cd apps/wbtimeline && yarn dev
```

More

Managing packages
- How do I add a package?