Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (23 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 1.03 KB
Raw

Contribution Guidelines

We value our contributors. Every bit of extra knowledge is greatly appreciated. Here are the guidelines in order to contribute to the project.

Installation

The project installation is fairly simple.

  1. Clone the repo
  2. Have nodejs/npm installed
  3. cd local_project_directory/client
  4. Run npm install --legcay-peer-deps

Running the app

  1. cd local_project_directory/client
  2. Run npm start
  3. Visit http://localhost:3000

Adding to the project

  1. Create a new branch by running:
  • git checkout -b branch_name
  • git push --set-upstream origin branch_name
  1. Make your changes
  2. Commit convention. When writing your commits please use one of the following structure depending on the type of work you did:
  • feature: short message (A new feature addition to the platform)
  • refactor: short message (A code refactoring change)
  • doc: short message (A documentation change)
  • bug: short message (A bug fix)
  1. Create a pull request and we will review it.