Guideline on how to contribute to the project

When contributing to the project, please follow these guidelines:

Please note, the above guideline is a prequisite for this project.

Contributing to the project

Fork the repository on GitHub
Clone the repository on your local machine git clone https://github.com/JengaBay/jenga_bay.git
CD into the directory $cd jenga_bay on your machine
CD into the Directory $cd frontendon your machine
Run yarn to install all the dependencies
Run yarn start on directories frontendto start the server
Launch your browser and go to http://localhost:3000

Pull Requests Process

$ git add .

$ git commit -m "your-message"

the component you worked on

$ git remote -v

check your remote branches

$ git remote add upstream git@github:JengaBay/jenga_bay.git

Add upstream to repo directory to the upstream forked repository

$ git fetch upstream

Fetch from the upstream branch if there's an update

$ git checkout -b <your_branch_name>

Checkout your branch name here

$ git push upstream

Push the code to the upstream branch and make a pull-request to the dev branch

THANK YOU FOR READING THIS DOCUMENTATION.