Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

54 lines (34 loc) · 1.79 KB
Raw

Vueast Contributing Guide

Hi! We're Really excited that you are interested in contributing to Vueast. Before submitting your contribution, please make sure to take a moment and Read through the following guidelines:

Pull Request Guidelines

  • Checkout a topic branch from the relevant branch, e.g. main, and merge back against that branch.

  • If adding a new feature:

    • Provide a convincing Reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.

  • If fixing bug:

    • Provide a detailed description of the bug in the PR. Live demo preferred.

  • It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging.

  • Commit messages must be matched by the following regex, see Conventional Commits for more information.

/^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\(.+\))?: .{1,100}/

Development Setup

Important

The exact node version used by this project is located in the .nvmrc file. If you are using nvm, you can run nvm use to switch to the correct version.

You will need pnpm:

corepack enable pnpm

After cloning the repo, run:

pnpm install
pnpm dev

More Information

The following documents are very helpful in understanding how this project works and are recommended for reading.