Skip to content

Commit 3c3cf25

Browse files
docs: update contribution docs
1 parent 82ca2e3 commit 3c3cf25

File tree

2 files changed

+38
-4
lines changed

2 files changed

+38
-4
lines changed

Diff for: .github/CONTRIBUTING.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ Hi! I’m really excited that you are interested in contributing to Vue Test Uti
1515

1616
## Pull Request Guidelines
1717

18-
- The `master` branch is basically just a snapshot of the latest stable release. All development should be done in dedicated branches. **Do not submit PRs against the `master` branch.**
19-
2018
- Checkout a topic branch from the relevant branch, e.g. `dev`, and merge back against that branch.
2119

2220
- Work in the `src` folder and **DO NOT** checkin `dist` in the commits.
@@ -37,11 +35,11 @@ Hi! I’m really excited that you are interested in contributing to Vue Test Uti
3735

3836
### Committing Changes
3937

40-
Commit messages should follow the [commit message convention](./COMMIT_CONVENTION.md) so that changelogs can be automatically generated. Commit messages will be automatically validated upon commit. If you are not familiar with the commit message convention, you can use `npm run commit` or `yarn commit` instead of `git commit`, which provides an interactive CLI for generating proper commit messages.
38+
Commit messages should follow the [commit message convention](./COMMIT_CONVENTION.md) so that changelogs can be automatically generated. Commit messages will be automatically validated upon commit. If you are not familiar with the commit message convention, you can use `yarn commit` instead of `git commit`, which provides an interactive CLI for generating proper commit messages.
4139

4240
## Development Setup
4341

44-
You will need [Node.js](http://nodejs.org) **version 6+**
42+
You will need [Node.js](http://nodejs.org) **version 10+**
4543

4644
Vue Test Utils is a monorepo. It contains a root `package.json` for running scripts across the project. The code is inside separate packages in the `packages` directory. The project uses [lerna](https://lerna.js.org/) to manage the workspaces and should be run using [yarn](https://yarnpkg.com/lang/en/).
4745

Diff for: .github/PULL_REQUEST_TEMPLATE.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<!--
2+
Please make sure to read the Pull Request Guidelines:
3+
https://github.com/vuejs/vue-test-utils/blob/dev/.github/CONTRIBUTING.md#pull-request-guidelines
4+
-->
5+
6+
<!-- PULL REQUEST TEMPLATE -->
7+
<!-- (Update "[ ]" to "[x]" to check a box) -->
8+
9+
**What kind of change does this PR introduce?** (check at least one)
10+
11+
- [ ] Bugfix
12+
- [ ] Feature
13+
- [ ] Code style update
14+
- [ ] Refactor
15+
- [ ] Build-related changes
16+
- [ ] Other, please describe:
17+
18+
**Does this PR introduce a breaking change?** (check one)
19+
20+
- [ ] Yes
21+
- [ ] No
22+
23+
If yes, please describe the impact and migration path for existing applications:
24+
25+
**The PR fulfills these requirements:**
26+
27+
- [ ] It's submitted to the `dev` branch.
28+
- [ ] When resolving a specific issue, it's referenced in the PR's title (e.g. `fix #xxx[,#xxx]`, where "xxx" is the issue number)
29+
- [ ] All tests are passing: https://github.com/vuejs/vue-test-utils/blob/dev/.github/CONTRIBUTING.md#development-setup
30+
- [ ] New/updated tests are included
31+
32+
If adding a **new feature**, the PR's description includes:
33+
34+
- [ ] A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)
35+
36+
**Other information:**

0 commit comments

Comments
 (0)