Skip to content

docs: update CONTRIBUTING and README #2052

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 29, 2020
Merged

docs: update CONTRIBUTING and README #2052

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af9ba65
docs: update contributing.md
Nov 30, 2019
e703163
docs: update README
Nov 30, 2019
4ab935a
docs: update
Nov 30, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 41 additions & 21 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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 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
### 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.
Expand All @@ -71,12 +77,26 @@ yarn test

### Substantial Changes

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

## Code Specification

> 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`
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
```
Expand All @@ -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

Expand Down