Skip to content

Latest commit

 

History

History
49 lines (29 loc) · 1.64 KB

contributing.md

File metadata and controls

49 lines (29 loc) · 1.64 KB
Raw

VitePress Contributing Guide

Hi! We're really excited that you are interested in contributing to VitePress. 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 follow the commit message convention so that changelogs can be automatically generated.

Development Setup

You will need pnpm

After cloning the repo, run:

# install the dependencies of the project
$ pnpm install

Setup VitePress Dev Environment

You may start VitePress local dev environment by running pnpm run dev.

$ pnpm run dev

The easiest way to start testing out VitePress is to tweak the VitePress docs. You may run pnpm run docs folder to boot up VitePress documentation site locally, with live reloading of the source code.

$ pnpm run docs

After executing the above command, visit http://localhost:3000 and try modifying the source code. You'll get live update.