Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

43 lines (27 loc) · 1.69 KB
Raw

Contributing

If you want to contribute, you must read and accept our Code of Conduct.

Monorepo structure

package Description Documentation
app The web application built with React and Typescript app docs
assets All the SVG assets and design files assets docs
functions Endpoints deployed as Netlify functions functions docs

Getting started

Prerequisites

  • yarn >=1.17.0

Install

yarn install

It will execute a postinstall command copying all SVG files from assets package to the app and functions packages.

Usage

yarn start

Guidelines

General guidelines

  • The master branch is the production branch.
  • All new features / bugs should be done in a dedicated branch from the master branch.
  • On each PR you will have a preview app deployed on Netlify

Commit messages

This project uses gitmoji as commit convention, because it's fun and provides an easy way of identifying the purpose or intention of a commit with only looking at the emojis used. All you just have to do is to find the emoji corresponding to the purpose of your commit in this list following by a short message explaining the update. You can also add a description if it's needed. That's all ;)