Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

35 lines (26 loc) · 1.06 KB

GPortfolio Contributing Guide

Pull Request Guidelines

  • Create all pull requests from main. Do not include other pull requests that have not been merged yet.
  • Limit each pull request to one feature. If you have made several changes, please submit multiple pull requests.
  • If you add a new feature provide tests that specify how the feature works.
  • Respect the coding conventions
  • Do not include the number of a related issue in the title of a pull request. Give the pull request a descriptive title and reference any issues from the description.

Development Setup

The pnpm package manager is used to handle dependencies.

# Install dependencies
$ pnpm i --frozen-lockfile
# make up
# make down

# Run tests
$ pnpm test
# make test

# Run linter
$ pnpm lint:fix
# make lint

# Run docs
$ pnpm dev