From cf2553b0e400e18f13ebba2c8d16ba7159598293 Mon Sep 17 00:00:00 2001 From: Eduardo San Martin Morote Date: Tue, 22 Sep 2020 10:58:47 +0200 Subject: [PATCH] docs: update .github --- .github/ISSUE_TEMPLATE/bug_report.md | 31 ++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++ .github/PULL_REQUEST_TEMPLATE.md | 1 + .github/commit-convention.md | 91 +++++++++++++++++++++++ .github/dependabot.yml | 9 +++ .github/funding.yml | 1 - .github/workflows/release-tag.yml | 23 ++++++ 7 files changed, 175 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/commit-convention.md create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/release-tag.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..e932fbfe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,31 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' +--- + +### Reproduction + +If possible, provide a boiled down editable reproduction using a service like JSFiddle, Codepen or CodeSandbox. A failing unit test is even better! Otherwise provide as much information as possible to reproduce the problem. +If no reproduction is provided and the information is not enough to reproduce the problem, we won't be able to give it a look + +### Steps to reproduce the behavior + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +### Expected behavior + +A clear and concise description of what you expected to happen. + +### Actual behavior + +A clear and concise description of what actually happens. + +### Additional information + +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..27a8eb2b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: feature request +assignees: '' + +--- + +### What problem is this solving + +A clear and concise description of what the problem is. Ex. when using the function X we cannot do Y. + +### Proposed solution + +A clear and concise description of what you want to happen with an API proposal when applicable + +### Describe alternatives you've considered + +A clear and concise description of any alternative solutions or features you've considered. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index efcf371f..a7761bd8 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,6 +5,7 @@ https://github.com/vuejs/vue/blob/dev/.github/CONTRIBUTING.md#Pull-Request + **What kind of change does this PR introduce?** (check at least one) diff --git a/.github/commit-convention.md b/.github/commit-convention.md new file mode 100644 index 00000000..665b1da3 --- /dev/null +++ b/.github/commit-convention.md @@ -0,0 +1,91 @@ +## Git Commit Message Convention + +> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular). + +#### TL;DR: + +Messages must be matched by the following regex: + +```text +/^(revert: )?(feat|fix|docs|dx|style|refactor|perf|test|workflow|build|ci|chore|types|wip)(\(.+\))?: .{1,50}/ +``` + +#### Examples + +Appears under "Features" header, `link` subheader: + +``` +feat(link): add `force` option +``` + +Appears under "Bug Fixes" header, `view` subheader, with a link to issue #28: + +``` +fix(view): handle keep-alive with aborted navigations + +close #28 +``` + +Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation: + +``` +perf: improve guard extraction + +BREAKING CHANGE: The 'beforeRouteEnter' option has been removed. +``` + +The following commit and commit `667ecc1` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header. + +``` +revert: feat(compiler): add 'comments' option + +This reverts commit 667ecc1654a317a13331b17617d973392f415f02. +``` + +### Full Message Format + +A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**: + +``` +(): + + + +