From af9ba658c84cee482bc7127abdb4b714560681e6 Mon Sep 17 00:00:00 2001 From: ludanxer Date: Sat, 30 Nov 2019 15:38:55 +0800 Subject: [PATCH 1/3] docs: update contributing.md --- .github/CONTRIBUTING.md | 60 +++++++++++++++++++++++++++-------------- 1 file changed, 40 insertions(+), 20 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e9be3ec8b4..4b8625defa 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -3,26 +3,30 @@ 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/). ``` sh -# Install dependencies & compile TypeScript utilities. -yarn bootstrap +# Install all dependencies. +yarn install -# Clean dependencies. -yarn clean - -# Useful when creating new submodules. -yarn boot - -# Serve the docs. +# Serves VuePress' own docs with itself. yarn dev -# Build the docs. +# Build VuePress' own docs with itself. yarn build # Execute all the test suites. yarn test + +# Clean dependencies. +yarn clean + +# Useful when creating new submodules. +yarn boot ``` -## Core packages +## Testing Setup + +> TODO + +## Core Packages - **docs**: Docs of VuePress (do not publish to npm). - **vuepress**: VuePress CLI. @@ -42,21 +46,23 @@ yarn test - `theme-default`: default theme. - `theme-vue`: a theme tweak from default theme, used for the official Vue project. -## Core packages not in main project +## Core Packages not in Main Project -> Previously, for quick iteration, these projects were kept in ULIVZ's workspace. In the future, we may want to build an independent GitHub group. +These projects are now available under [VuePress](https://github.com/vuepressjs) group, contribution welcome! -- [awesome-vuepress](https://github.com/ulivz/awesome-vuepress) -- [@vuepress/plugin-blog](https://github.com/ulivz/vuepress-plugin-blog) -- [@vuepress/theme-blog](https://github.com/ulivz/vuepress-theme-blog) +- [awesome-vuepress](https://github.com/vuepressjs/awesome-vuepress) +- [@vuepress/plugin-blog](https://github.com/vuepressjs/vuepress-plugin-blog) +- [@vuepress/theme-blog](https://github.com/vuepressjs/vuepress-theme-blog) ## Workflow ### Issue -> TODO +Use one of the [issues templates](https://github.com/vuejs/vuepress/issues/new/choose) when you open a issue, and **do not delete the issue template**. + +Please ask questions on the [StackOverflow](https://stackoverflow.com/questions/ask?tags=vuepress). -### Pull requests +### Pull Requests - Create a feature branch from the default branch (`master`) and merge back against that branch. - It's OK to have multiple small commits as you work on the PR - GitHub automatically squashes them before merging. @@ -77,6 +83,20 @@ yarn test > TODO -## Commit specification +## Commit Specification + +Commit messages should follow the [commit message convention](https://www.conventionalcommits.org) so that changelogs can be automatically generated. + +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: + +``` sh +cli + +# Core Packages/packages: +core +markdown +... +theme-vue +``` -Commit messages should follow the [commit message convention](./COMMIT_CONVENTION.md) so that changelogs can be automatically generated. +Correct examples would be: `fix($core): some message` or `feat: some message` From e7031633efd4802b1dd25e580d56bf86b189dc72 Mon Sep 17 00:00:00 2001 From: ludanxer Date: Sat, 30 Nov 2019 15:57:49 +0800 Subject: [PATCH 2/3] docs: update README --- .github/CONTRIBUTING.md | 6 +++--- README.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 4b8625defa..0d8768f497 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -58,9 +58,9 @@ These projects are now available under [VuePress](https://github.com/vuepressjs) ### Issue -Use one of the [issues templates](https://github.com/vuejs/vuepress/issues/new/choose) when you open a issue, and **do not delete the issue template**. +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). -Please ask questions on the [StackOverflow](https://stackoverflow.com/questions/ask?tags=vuepress). +We'll close your issue if you delete the template or it contains questions. ### Pull Requests @@ -77,7 +77,7 @@ Please ask questions on the [StackOverflow](https://stackoverflow.com/questions/ ### Substantial Changes -> RFC flow, TODO +Check out [RFC flow](https://github.com/vuejs/vuepress/tree/master/rfcs) for more detail. ## Code Specification diff --git a/README.md b/README.md index f820b62180..e0c9e69466 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ yarn add vuepress -D ## Showcase -- [Awesome VuePress](https://github.com/ulivz/awesome-vuepress) +- [Awesome VuePress](https://github.com/vuepressjs/awesome-vuepress) - [vuepress.gallery](https://vuepress.gallery) (by [@vicbergquist](https://twitter.com/vicbergquist)) ## Documentation @@ -37,10 +37,10 @@ Docs are available at https://vuepress.vuejs.org/ - we are still working on refi ## Contribution -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)! +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)! ```bash -yarn bootstrap # Install and link dependencies for this lerna repo +yarn install # install all dependencies yarn dev # serves VuePress' own docs with itself yarn test # make sure your code change pass the test ``` From 4ab935ac1c883e92a9f11db7d3b3f0ec28d99272 Mon Sep 17 00:00:00 2001 From: ludanxer Date: Sat, 30 Nov 2019 16:00:44 +0800 Subject: [PATCH 3/3] docs: update --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e0c9e69466..622911938f 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ If you don't have a local checkout, you can also open [VuePress in Gitpod](https If you intend to make `"substantial"` changes to VuePress or its documentation, please checkout [VuePress RFCs](./rfcs/README.md). -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)! +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)! ## Contributors