Skip to content
This repository has been archived by the owner on Dec 28, 2022. It is now read-only.

Latest commit

 

History

History
60 lines (39 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

60 lines (39 loc) · 1.57 KB
Raw

Contributing

Introduction

Thanks for contributing — you rock! 🤘

Git Workflow

  1. Create a feature branch off main
  2. Work locally adhering to coding standards
  3. Open a Pull Request (PR) and fill out the PR template
  4. Your PR must pass assertions and Vercel must complete a preview deployment successfully
  5. After peer review, the PR will be merged back into main
  6. Repeat ♻️

PR Preview Deployments

Vercel is connected to this Github repository and will automatically build and deploy a unique URL for each Pull Request.

Learn more about Vercel + Github integration.

Code Linting

This project has several rulesets and uses ESLint, Prettier, and Stylelint to enforce standards.

In addition to real-time linting, you could run the following commands in your terminal.

These commands are also used in a pre-commit hook.

Lint JavaScript:

npm run lint:js

Lint CSS:

npm run lint:css

Format your code:

npm run format

Tips to help your PR get approved

  1. Make sure your code editor supports real-time linting
  2. JSDocs are required for all JavaScript functions
  3. Run npm run build && npm run start before submitting your PR, to ensure a successful build
  4. Be courteous in your communications