Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

54 lines (37 loc) · 1.71 KB
Raw

How to contribute

Getting started

  1. Make sure that you have Node.js v18 or above installed. (We recommend v20)
  2. Install pnpm for managing dependencies. (We recommend v8)
  3. For code editor we recommend using Visual Studio Code.

Clone your own fork

  1. Fork the repository on GitHub.
  2. Clone the forked repository to your local machine.
  3. Open the cloned repository in your code editor.

Install dependencies

  1. Open a terminal in the cloned repository.
  2. Run the following command to install dependencies:
pnpm install
  1. Install pre-commit, and install pre-commit hooks:
pre-commit install

Start the development server

  1. Run the following command to start the development server:
pnpm docs:dev
  1. Make your changes and preview the result in the browser.

Commit your changes

  1. Before you commit any changes, make sure that your have gone through the checklist.
  2. After commit, push your changes to your forked repository.
  3. Create a pull request to the main repository.
  4. Wait for the pull request to be reviewed and merged. Thank you for your contribution!

Checklist

  • I have read the contributing guideline.
  • I have previewed the site using pnpm docs:dev to make sure that there are no rendering errors.
  • I have built the site using pnpm docs:build to make sure that there are no build errors.
  • I have installed pre-commit hooks.
  • I am using Conventional Commits.
  • I have clearly described the changes I made in the commit message.