Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

62 lines (42 loc) · 1.64 KB

CONTRIBUTING

Hi there! Thanks for your interest in contributing to this project!

To encourage active collaboration, pull requests are strongly encouraged, not just bug reports. "Bug reports" may also be sent in the form of a pull request containing a failing test. I'd also love to hear about ideas for new features as issues.

Please do:

  • Check existing issues to verify that the bug or feature request has not already been submitted.
  • Open an issue if things aren't working as expected.
  • Open an issue to propose a significant change.
  • open an issue to propose a feature
  • Open a pull request to fix a bug.
  • Open a pull request to fix documentation about a command.
  • Open a pull request for an issue with the help-wanted label and leave a comment claiming it.

RUNNING OR BUILDING THE PROJECT

Prerequisites

  • Node +12.2 or later.
  • Yarn +1.2.0 or later (or npm +6.14.5 or later).

Running or building the Project

Install dependencies

yarn install
# or
npm install

Run command

yarn run dev
# or
npm run dev

Build the Project

yarn run build
# or
npm run build

SUBMITTING YOUR PULL REQUEST

  • Create a new branch for your changes: git checkout -b branch-name.
  • Add your changes and make sure there are no breakages in code, builds and dependencies.
  • Submit your pull request.

COMMIT MESSAGES

Your commit messages should be semantic.

A commit message consists of a header, a body and a footer, separated by a blank line.

Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.