Skip to content

Commit 6c87c3a

Browse files
committed
docs: add CONTRIBUTING.md
1 parent ebc6601 commit 6c87c3a

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CONTRIBUTING.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# `create-vue` Contributing Guide
2+
3+
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:
4+
5+
## Repo Setup
6+
7+
This repo uses [Git submodules](https://git-scm.com/book/en/v2/Git-Tools-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.
8+
9+
To download everything including submodules, run the following command:
10+
11+
```sh
12+
git clone --recursive https://github.com/vuejs/create-vue.git
13+
```
14+
15+
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.
16+
17+
This repo is a monorepo using pnpm workspaces. The package manager used to install and link dependencies must be [pnpm](https://pnpm.io/).
18+
19+
## Pull Request Guidelines
20+
21+
- Checkout a topic branch from a base branch, e.g. `main`, and merge back against that branch.
22+
- For any non-trivial new features or bug fixes, please open a issue first and have it approved before working on it.
23+
- Don't include the `playground` directory in the commits. It will be updated automatically after each release.

0 commit comments

Comments
 (0)