Skip to content

Latest commit

 

History

History
33 lines (25 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

33 lines (25 loc) · 1.35 KB
Raw

Contributing

If you have a proposal you want to share with us, follow the description below. You only need to follow the installation instructions if you want to contribute something.

Requirements

You need to have the following tools installed:

Installation

  • Fork this repository.
  • Clone the forked repository to your local machine.
  • Install project dependencies. In the project folder:
    • Run npm install
  • Start the web server:
    • Run npm start
  • Open http://localhost:3030 (or http://localhost:3030/index on Windows)

Make Your Changes

  • Make sure the master branch of your fork is up to date by syncing your fork.
  • Create a new feature branch from the latest master:
    • Run git checkout -b the-feature-name.
  • Make your changes, and save your files.
  • Commit and push your changes to the forked repository:
    • To commit, run git add -A && git commit -m "Meaningful commit message"
    • To push, run git push

Create a Pull Request

Create a pull request from the feature branch of the forked repository to the master branch of the original repository.

We will review your changes and get back to you.