CONTRIBUTING.md

Setting up dev environment

Prerequisites

1. VS code
2. WSL2 (only for Windows OS)
3. Git
4. Node, Yarn, NPM

Running projects

1. Clone the project on your local machine
2. Read the docs for running the project, and run.

Working on assigned issues

# Step 1 - Local - Create new branch
git checkout master # Go to master branch
git pull # Get latest master changes
git checkout -b fix/issue-headline-inshort # Create a new branch

# Step 2 - Local - Make changes in code

# Step 3 - Local - Push your changes
git status # To know which files have changed
git add . # Add all the changed files for upcoming commit
git commit -m "Fix related stuff"
git push

# Step 4 - Github - Create your Pull-request
# Step 5 - Github - Get it accepted
# Step 6 - Github - Merge it yourself