Skip to content

Latest commit

 

History

History
23 lines (13 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

23 lines (13 loc) · 1.37 KB
Raw

Contribution guide

Setup

  1. Make sure you have the correct version of Node installed. If you use nvm, run nvm use. If you use asdf, run asdf install.
  2. Make sure you have yarn ^1.0.0 installed: npm install --global yarn
  3. Install dependencies with yarn

Run locally

Use yarn dev to run in dev mode.

See package.json for other scripts that can be run (e.g. linters).

Committing code

We use commitlint to lint our commit messages. If your commit message doesn't fit this format, it'll be rejected by a pre-commit hook.

Renovate

We use Renovate to manage dependencies. The config file is at .github/renovate.json.

We seek to maintain a balance between thoroughly checking each dependency and spending too much time maintaining dependencies, so our settings are designed to safely reduce noise reduction from dependency updates, like scheduling updates outside of working hours, combining some PRs, and automatically merging dependencies where we can be 100% confident in our CI's ability to catch problems. For example, we automerge linter PRs because it's virtually impossible for them to break something in production as they only check code, they don't affect any functionality.