Skip to content

Commit 6918792

Browse files
chore: use a gitflow-like workflow for the project (#4416)
* chore: use a gitflow-like workflow for the project * Update .github/CONTRIBUTING.md Co-Authored-By: Natalia Tepluhina <NataliaTepluhina@users.noreply.github.com>
1 parent 428d172 commit 6918792

File tree

3 files changed

+43
-0
lines changed

3 files changed

+43
-0
lines changed

.github/COMMIT_CONVENTION.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ A commit message consists of a **header**, **body** and **footer**. The header
5656

5757
The **header** is mandatory and the **scope** of the header is optional.
5858

59+
A `!` MAY be appended prior to the `:` in the type/scope prefix, to further draw attention to breaking changes. `BREAKING CHANGE:` description MUST also be included in the body or footer, along with the `!` in the prefix.
60+
5961
### Revert
6062

6163
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.

.github/CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
## Workflow
2+
3+
The Git workflow used in this project is largely inspired by [Gitflow workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow).
4+
5+
There are two main branches: `master` and `next`, corresponding to the npm `dist-tag`s with the same names.
6+
The documentation website for the current CLI version <https://cli.vuejs.org> is deployed from the `master` branch, while documentation for new features <https://next.cli.vuejs.org/> is deployed from `next` branch.
7+
8+
When sending documentation pull requests, please fork your branches from these two branches.
9+
10+
The development branch is `dev`.
11+
And there are several version branches for archiving old versions of Vue CLI, such as `v2`, `v3`.
12+
13+
Pull requests that touches the code should be forked from `dev`, unless it's only targeting an old version.
14+
115
## Development Setup
216

317
This project uses a monorepo setup that requires using [Yarn](https://yarnpkg.com) because it relies on [Yarn workspaces](https://yarnpkg.com/blog/2017/08/02/introducing-workspaces/).

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!-- Please don't delete this template -->
2+
3+
<!-- PULL REQUEST TEMPLATE -->
4+
<!-- (Update "[ ]" to "[x]" to check a box) -->
5+
6+
**What kind of change does this PR introduce?** (check at least one)
7+
8+
- [ ] Bugfix
9+
- [ ] Feature
10+
- [ ] Code style update
11+
- [ ] Refactor
12+
- [ ] Docs
13+
- [ ] Underlying tools
14+
- [ ] Other, please describe:
15+
16+
<!--
17+
Note:
18+
When submitting documentation PRs, please target the `master` branch (https://cli.vuejs.org) or `next` branch (https://next.cli.vuejs.org)
19+
When submitting coding PRs, please target the `dev` branch.
20+
-->
21+
22+
**Does this PR introduce a breaking change?** (check one)
23+
24+
- [ ] Yes
25+
- [ ] No
26+
27+
**Other information:**

0 commit comments

Comments
 (0)