Skip to content

Commit 3abe265

Browse files
author
Sun Haoran
authored
docs: update CONTRIBUTING and README (#2052)
1 parent 369c315 commit 3abe265

File tree

2 files changed

+45
-25
lines changed

2 files changed

+45
-25
lines changed

.github/CONTRIBUTING.md

Lines changed: 41 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,30 @@
33
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/).
44

55
``` sh
6-
# Install dependencies & compile TypeScript utilities.
7-
yarn bootstrap
6+
# Install all dependencies.
7+
yarn install
88

9-
# Clean dependencies.
10-
yarn clean
11-
12-
# Useful when creating new submodules.
13-
yarn boot
14-
15-
# Serve the docs.
9+
# Serves VuePress' own docs with itself.
1610
yarn dev
1711

18-
# Build the docs.
12+
# Build VuePress' own docs with itself.
1913
yarn build
2014

2115
# Execute all the test suites.
2216
yarn test
17+
18+
# Clean dependencies.
19+
yarn clean
20+
21+
# Useful when creating new submodules.
22+
yarn boot
2323
```
2424

25-
## Core packages
25+
## Testing Setup
26+
27+
> TODO
28+
29+
## Core Packages
2630

2731
- **docs**: Docs of VuePress (do not publish to npm).
2832
- **vuepress**: VuePress CLI.
@@ -42,21 +46,23 @@ yarn test
4246
- `theme-default`: default theme.
4347
- `theme-vue`: a theme tweak from default theme, used for the official Vue project.
4448

45-
## Core packages not in main project
49+
## Core Packages not in Main Project
4650

47-
> Previously, for quick iteration, these projects were kept in ULIVZ's workspace. In the future, we may want to build an independent GitHub group.
51+
These projects are now available under [VuePress](https://github.com/vuepressjs) group, contribution welcome!
4852

49-
- [awesome-vuepress](https://github.com/ulivz/awesome-vuepress)
50-
- [@vuepress/plugin-blog](https://github.com/ulivz/vuepress-plugin-blog)
51-
- [@vuepress/theme-blog](https://github.com/ulivz/vuepress-theme-blog)
53+
- [awesome-vuepress](https://github.com/vuepressjs/awesome-vuepress)
54+
- [@vuepress/plugin-blog](https://github.com/vuepressjs/vuepress-plugin-blog)
55+
- [@vuepress/theme-blog](https://github.com/vuepressjs/vuepress-theme-blog)
5256

5357
## Workflow
5458

5559
### Issue
5660

57-
> TODO
61+
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.
5864

59-
### Pull requests
65+
### Pull Requests
6066

6167
- Create a feature branch from the default branch (`master`) and merge back against that branch.
6268
- 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
7177

7278
### Substantial Changes
7379

74-
> RFC flow, TODO
80+
Check out [RFC flow](https://github.com/vuejs/vuepress/tree/master/rfcs) for more detail.
7581

7682
## Code Specification
7783

7884
> TODO
7985
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+
```
81101

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`

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,16 @@ Check out our docs at https://vuepress.vuejs.org/.
2323

2424
## Showcase
2525

26-
- [Awesome VuePress](https://github.com/ulivz/awesome-vuepress)
26+
- [Awesome VuePress](https://github.com/vuepressjs/awesome-vuepress)
2727
- [vuepress.gallery](https://vuepress.gallery) (by [@vicbergquist](https://twitter.com/vicbergquist))
2828
- [vuepress.tools](https://vuepress.tools/) (By [Ahmad Mostafa](https://ahmadmostafa.com))
2929

3030
## Contribution
3131

32-
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)!
3333

3434
```bash
35-
yarn bootstrap # Install and link dependencies for this lerna repo
35+
yarn install # install all dependencies
3636
yarn dev # serves VuePress' own docs with itself
3737
yarn test # make sure your code change pass the test
3838
```
@@ -41,7 +41,7 @@ If you don't have a local checkout, you can also open [VuePress in Gitpod](https
4141

4242
If you intend to make `"substantial"` changes to VuePress or its documentation, please checkout [VuePress RFCs](./rfcs/README.md).
4343

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)!
4545

4646
## Contributors
4747

0 commit comments

Comments
 (0)