Skip to content

Commit 0fb54ae

Browse files
kiakingkiaking
authored
build: add conventional changelog support (vuejs#1707)
* build: add conventional changelog support * chore: fix changelog script typos
1 parent e52756c commit 0fb54ae

File tree

7 files changed

+1089
-11
lines changed

7 files changed

+1089
-11
lines changed

‎.github/commit-convention.md

+91
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
## Git Commit Message Convention
2+
3+
> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).
4+
5+
#### TL;DR:
6+
7+
Messages must be matched by the following regex:
8+
9+
``` js
10+
/^(revert: )?(feat|fix|docs|dx|style|refactor|perf|test|workflow|build|ci|chore|types|wip)(\(.+\))?: .{1,50}/
11+
```
12+
13+
#### Examples
14+
15+
Appears under "Features" header, `store` subheader:
16+
17+
```
18+
feat(store): add 'watch' option
19+
```
20+
21+
Appears under "Bug Fixes" header, `module` subheader, with a link to issue #28:
22+
23+
```
24+
fix(module): handle state overwrite
25+
26+
close #28
27+
```
28+
29+
Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:
30+
31+
```
32+
perf: improve store getters performance by removing 'foo' option
33+
34+
BREAKING CHANGE: The 'foo' option has been removed.
35+
```
36+
37+
The following commit and commit `667ecc1` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.
38+
39+
```
40+
revert: feat(store): add 'watch' option
41+
42+
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
43+
```
44+
45+
### Full Message Format
46+
47+
A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:
48+
49+
```
50+
<type>(<scope>): <subject>
51+
<BLANK LINE>
52+
<body>
53+
<BLANK LINE>
54+
<footer>
55+
```
56+
57+
The **header** is mandatory and the **scope** of the header is optional.
58+
59+
### Revert
60+
61+
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.
62+
63+
### Type
64+
65+
If the prefix is `feat`, `fix` or `perf`, it will appear in the changelog. However, if there is any [BREAKING CHANGE](#footer), the commit will always appear in the changelog.
66+
67+
Other prefixes are up to your discretion. Suggested prefixes are `docs`, `chore`, `style`, `refactor`, and `test` for non-changelog related tasks.
68+
69+
### Scope
70+
71+
The scope could be anything specifying the place of the commit change. For example `core`, `compiler`, `ssr`, `v-model`, `transition` etc...
72+
73+
### Subject
74+
75+
The subject contains a succinct description of the change:
76+
77+
* use the imperative, present tense: "change" not "changed" nor "changes"
78+
* don't capitalize the first letter
79+
* no dot (.) at the end
80+
81+
### Body
82+
83+
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
84+
The body should include the motivation for the change and contrast this with previous behavior.
85+
86+
### Footer
87+
88+
The footer should contain any information about **Breaking Changes** and is also the place to
89+
reference GitHub issues that this commit **Closes**.
90+
91+
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.

‎.github/contributing.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Vuex Contributing Guide
2+
3+
Hi! We're really excited that you are interested in contributing to Vuex. Before submitting your contribution, please make sure to take a moment and read through the following guidelines:
4+
5+
- [Code of Conduct](https://github.com/vuejs/vue/blob/dev/.github/CODE_OF_CONDUCT.md)
6+
- [Issue Reporting Guidelines](#issue-reporting-guidelines)
7+
- [Pull Request Guidelines](#pull-request-guidelines)
8+
9+
## Issue Reporting Guidelines
10+
11+
- Always use [https://new-issue.vuejs.org/](https://new-issue.vuejs.org/) to create new issues.
12+
13+
## Pull Request Guidelines
14+
15+
- The `master` branch is just a snapshot of the latest stable release. All development should be done in dedicated branches. **Do not submit PRs against the `master` branch.**
16+
17+
- Checkout a topic branch from the relevant branch, e.g. `dev`, and merge back against that branch.
18+
19+
- Work in the `src` folder and **DO NOT** checkin `dist` in the commits.
20+
21+
- If adding a new feature:
22+
23+
- Add accompanying test case.
24+
- Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.
25+
26+
- If fixing bug:
27+
28+
- If you are resolving a special issue, add `(fix #xxxx[,#xxxx])` (#xxxx is the issue id) in your PR title for a better release log, e.g. `update state re-evaluation (fix #3899)`.
29+
- Provide a detailed description of the bug in the PR. Live demo preferred.
30+
31+
- It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging.
32+
33+
- Make sure tests pass!
34+
35+
- Commit messages must follow the [commit message convention](./commit-convention.md) so that changelogs can be automatically generated.

0 commit comments

Comments
 (0)