Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

35 lines (22 loc) · 1.28 KB
Raw

Contributing to Documate

Thanks for your interest in contributing to Documate! Please take a moment to review this document before submitting a pull request.

Pull Requests

Before starting work on any significant new features, please create an issue to first discuss it. If you are making changes to the UI components, make sure to update both the Vue and React versions so that we can ensure feature parity.

  • Checkout a topic branch from the relevant branch, and merge back against that branch.
  • If adding a new feature, please link to a corresponding issue in the PR description.
  • If fixing a bug, please provide a detailed description of the bug in the PR description. Live demo preferred.

Development Setup

We use pnpm as the package manager. You need to install it before proceeding.

Installation

After cloning the repo, cd into the corresponding directory and run pnpm install to install the dependencies.

pnpm install

Running Dev Server

You can start the dev server by running the following command:

pnpm run dev