Skip to content

Latest commit

 

History

History
43 lines (25 loc) · 1.56 KB

contributing.md

File metadata and controls

43 lines (25 loc) · 1.56 KB
Raw

VitePress Blog Contributing Guide

Hi! We're really excited that you are interested in contributing to VitePress Blog. 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 Blog Dev Environment

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

$ pnpm run dev

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