Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

34 lines (21 loc) · 1.9 KB
Raw

create-vue Contributing Guide

Hi! We are really excited that you are interested in contributing to create-vue. Before submitting your contribution, please make sure to take a moment and read through the following guide:

Repo Setup

This repo uses Git submodules to store snapshots of the created templates after each release. So when cloning the repository, please make sure you have also initialized the submodules.

To download everything including submodules, run the following command:

git clone --recursive https://github.com/vuejs/create-vue.git

If you have already cloned the repo but without adding the --recursive flag, please run git submodule update --init --recursive to initialize and update the submodule.

This repo is a monorepo using pnpm workspaces. The package manager used to install and link dependencies must be pnpm.

Pull Request Guidelines

  • Checkout a topic branch from a base branch, e.g. main, and merge back against that branch.
  • For any non-trivial new features or bug fixes, please open an issue first and have it approved before working on it.
  • Don't include the playground directory in the commits. It will be updated automatically after each release.

Node.js Compatibility

This project should be able to run on all maintained Node.js LTS versions. This is ensured by GitHub Actions running the test suite on multiple Node.js versions. Once an LTS version reaches its end-of-life, we will drop support for it.

We encourage users to use the latest active LTS version for development. Consequently, the @tsconfig/node* and @types/node dependencies used in the generated TypeScript projects are set to be in sync with the latest active LTS Node.js version.

The Node.js release schedule can be found at Node.js Release Working Group.