From d49acc7fa3bc44c7d522aa8dc276949ef8998567 Mon Sep 17 00:00:00 2001 From: Haoqun Jiang Date: Fri, 9 Aug 2019 20:05:41 +0800 Subject: [PATCH 1/2] chore: use a gitflow-like workflow for the project --- .github/COMMIT_CONVENTION.md | 2 ++ .github/CONTRIBUTING.md | 14 ++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 27 +++++++++++++++++++++++++++ 3 files changed, 43 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/COMMIT_CONVENTION.md b/.github/COMMIT_CONVENTION.md index 05e4786d68..6aaffa749a 100644 --- a/.github/COMMIT_CONVENTION.md +++ b/.github/COMMIT_CONVENTION.md @@ -56,6 +56,8 @@ A commit message consists of a **header**, **body** and **footer**. The header The **header** is mandatory and the **scope** of the header is optional. +A `!` MAY be appended prior to the `:` in the type/scope prefix, to further draw attention to breaking changes. `BREAKING CHANGE:` description MUST also be included in the body or footer, along with the `!` in the prefix. + ### Revert 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 .`, where the hash is the SHA of the commit being reverted. diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 56e1fd9971..d1cf5d656c 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,3 +1,17 @@ +## Workflow + +The Git workflow used in this project is largely inspired by [Gitflow workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow). + +There are two main branches: `master` and `next`, corresponding to the npm `dist-tag`s with the same names. +The documentation website is deployed from the `master` branch, with from `next`. + +When sending documentation pull requests, please fork your branches from these two branches. + +The development branch is `dev`. +And there are several version branches for archiving old versions of Vue CLI, such as `v2`, `v3`. + +Pull requests that touches the code should be forked from `dev`, unless it's only targeting an old version. + ## Development Setup 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/). diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..55a5b2a458 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,27 @@ + + + + + +**What kind of change does this PR introduce?** (check at least one) + +- [ ] Bugfix +- [ ] Feature +- [ ] Code style update +- [ ] Refactor +- [ ] Docs +- [ ] Underlying tools +- [ ] Other, please describe: + + + +**Does this PR introduce a breaking change?** (check one) + +- [ ] Yes +- [ ] No + +**Other information:** From 3cf3335806bf6bf9cc177b2dedce3a12bdb9cc95 Mon Sep 17 00:00:00 2001 From: Haoqun Jiang Date: Sat, 10 Aug 2019 15:11:01 +0800 Subject: [PATCH 2/2] Update .github/CONTRIBUTING.md Co-Authored-By: Natalia Tepluhina --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d1cf5d656c..5eb8134fb0 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -3,7 +3,7 @@ The Git workflow used in this project is largely inspired by [Gitflow workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow). There are two main branches: `master` and `next`, corresponding to the npm `dist-tag`s with the same names. -The documentation website is deployed from the `master` branch, with from `next`. +The documentation website for the current CLI version is deployed from the `master` branch, while documentation for new features is deployed from `next` branch. When sending documentation pull requests, please fork your branches from these two branches.