Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 983 Bytes

CONTRIBUTING.md

File metadata and controls

38 lines (25 loc) · 983 Bytes

Contributing Guide

Contributions are welcome and are greatly appreciated!

Requirements

You must have all the following applications installed:

Running the documentation locally

After forking and cloning this repository, do the following steps to get started:

$ yarn
$ yarn start

After this, point your browser to the specified port (defaults to http://localhost:4000).

The browser will automatically refresh when there are changes to any of the source files.

Git commit message pattern

  1. Capitalize the subject line.
  2. Do not end the subject line with a period.
  3. Use the imperative mood in the subject line.
  4. End the commit with the emoji that describes your change. The description of emojis for commits is available here.

Examples:

- Add feature X ✨
- Update getting started documentation 📝
- Fix a bug X 🐛