You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+41-21Lines changed: 41 additions & 21 deletions
Original file line number
Diff line number
Diff line change
@@ -3,26 +3,30 @@
3
3
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/).
Use one of the [issues templates](https://github.com/vuejs/vuepress/issues/new/choose) when you open a issue. And please ask questions on the [StackOverflow](https://stackoverflow.com/questions/ask?tags=vuepress).
62
+
63
+
We'll close your issue if you delete the template or it contains questions.
58
64
59
-
### Pull requests
65
+
### Pull Requests
60
66
61
67
- Create a feature branch from the default branch (`master`) and merge back against that branch.
62
68
- It's OK to have multiple small commits as you work on the PR - GitHub automatically squashes them before merging.
@@ -71,12 +77,26 @@ yarn test
71
77
72
78
### Substantial Changes
73
79
74
-
> RFC flow, TODO
80
+
Check out [RFC flow](https://github.com/vuejs/vuepress/tree/master/rfcs) for more detail.
75
81
76
82
## Code Specification
77
83
78
84
> TODO
79
85
80
-
## Commit specification
86
+
## Commit Specification
87
+
88
+
Commit messages should follow the [commit message convention](https://www.conventionalcommits.org) so that changelogs can be automatically generated.
89
+
90
+
Check out the availalbe types at [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional#type-enum). And the scopes should be one of the followings:
91
+
92
+
```sh
93
+
cli
94
+
95
+
# Core Packages/packages:
96
+
core
97
+
markdown
98
+
...
99
+
theme-vue
100
+
```
81
101
82
-
Commit messages should follow the [commit message convention](./COMMIT_CONVENTION.md) so that changelogs can be automatically generated.
102
+
Correct examples would be: `fix($core): some message` or `feat: some message`
Want to contribute? Check our [issues for beginners](https://github.com/vuejs/vuepress/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)!
32
+
Want to contribute? Check our [Contributing Guide](.github/CONTRIBUTING.md) and [issues for beginners](https://github.com/vuejs/vuepress/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)!
33
33
34
34
```bash
35
-
yarn bootstrap#Install and link dependencies for this lerna repo
35
+
yarn install#install all dependencies
36
36
yarn dev # serves VuePress' own docs with itself
37
37
yarn test# make sure your code change pass the test
38
38
```
@@ -41,7 +41,7 @@ If you don't have a local checkout, you can also open [VuePress in Gitpod](https
41
41
42
42
If you intend to make `"substantial"` changes to VuePress or its documentation, please checkout [VuePress RFCs](./rfcs/README.md).
43
43
44
-
If you have a VuePress-related project/component/tool, add it with a pull request to [this curated list](https://github.com/ulivz/awesome-vuepress)!
44
+
If you have a VuePress-related project/component/tool, add it with a pull request to [this curated list](https://github.com/vuepressjs/awesome-vuepress)!
0 commit comments