mirror of
https://gitee.com/bootx/dax-pay-ui.git
synced 2025-09-06 04:09:36 +00:00
chore: add .github and .vscode
This commit is contained in:
vben
39
.github/ISSUE_TEMPLATE/1-bug.md
vendored
Normal file
39
.github/ISSUE_TEMPLATE/1-bug.md
vendored
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
name: 🐛 Bug report
|
||||
about: Create a report to help us improve
|
||||
labels: 🔍 status/open, 🐛 type/bug
|
||||
---
|
||||
|
||||
<!--
|
||||
Ouch, sorry you’ve run into a bug. Thank for taking the time to report it!
|
||||
|
||||
Please fill in as much of the template below as you’re able.
|
||||
|
||||
P.S. have you seen our support and contributing docs?
|
||||
https://github.com/get-alex/.github/blob/master/support.md
|
||||
https://github.com/get-alex/.github/blob/master/contributing.md
|
||||
-->
|
||||
|
||||
### Subject of the issue
|
||||
|
||||
Describe your issue here.
|
||||
|
||||
### Your environment
|
||||
|
||||
- **OS**: <!-- Name and version of operating system -->
|
||||
- **Packages**: <!-- Names and version of required packages -->
|
||||
- **Env**: <!-- Version of node, npm, yarn, or names and versions of browser -->
|
||||
|
||||
### Steps to reproduce
|
||||
|
||||
Tell us how to reproduce this issue. Please provide a working and simplified example.
|
||||
|
||||
🎉 BONUS POINTS for creating a [minimal reproduction](https://stackoverflow.com/help/mcve) and uploading it to GitHub. This will get you the fastest support. 🎉
|
||||
|
||||
### Expected behaviour
|
||||
|
||||
What should happen?
|
||||
|
||||
### Actual behaviour
|
||||
|
||||
What happens instead?
|
||||
28
.github/ISSUE_TEMPLATE/2-feature.md
vendored
Normal file
28
.github/ISSUE_TEMPLATE/2-feature.md
vendored
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
name: 🚀 Feature request
|
||||
about: Suggest an idea for this project
|
||||
labels: 🔍 status/open, 🦋 type/enhancement
|
||||
---
|
||||
|
||||
<!--
|
||||
Thank you for suggesting an idea to make this project better!
|
||||
|
||||
Please fill in as much of the template below as you’re able.
|
||||
|
||||
-->
|
||||
|
||||
### Subject of the feature
|
||||
|
||||
Describe your issue here.
|
||||
|
||||
### Problem
|
||||
|
||||
If the feature requests relates to a problem, please describe the problem you are trying to solve here.
|
||||
|
||||
### Expected behaviour
|
||||
|
||||
What should happen? Please describe the desired behaviour.
|
||||
|
||||
### Alternatives
|
||||
|
||||
What are the alternative solutions? Please describe what else you have considered?
|
||||
15
.github/ISSUE_TEMPLATE/3-help.md
vendored
Normal file
15
.github/ISSUE_TEMPLATE/3-help.md
vendored
Normal file
@@ -0,0 +1,15 @@
|
||||
---
|
||||
name: Question 🤔
|
||||
about: Usage question or discussion about alex.
|
||||
labels: 🔍 status/open, 🙋 type/question
|
||||
---
|
||||
|
||||
<!--
|
||||
To make it easier for us to help you, please include as much useful information
|
||||
as possible.
|
||||
|
||||
Before opening a new issue, please search existing issues:
|
||||
https://github.com/search?q=org%3Aget-alex&type=Issues
|
||||
|
||||
|
||||
-->
|
||||
89
.github/commit-convention.md
vendored
Normal file
89
.github/commit-convention.md
vendored
Normal file
@@ -0,0 +1,89 @@
|
||||
## 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:
|
||||
|
||||
```js
|
||||
/^(revert: )?(feat|fix|docs|style|refactor|perf|test|workflow|build|ci|chore|types|wip): .{1,50}/;
|
||||
```
|
||||
|
||||
#### Examples
|
||||
|
||||
Appears under "Features" header, `dev` subheader:
|
||||
|
||||
```
|
||||
feat(dev): add 'comments' option
|
||||
```
|
||||
|
||||
Appears under "Bug Fixes" header, `dev` subheader, with a link to issue #28:
|
||||
|
||||
```
|
||||
fix(dev): fix dev error
|
||||
|
||||
close #28
|
||||
```
|
||||
|
||||
Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:
|
||||
|
||||
```
|
||||
perf(build): remove 'foo' option
|
||||
|
||||
BREAKING CHANGE: The 'foo' 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**:
|
||||
|
||||
```
|
||||
<type>(<scope>): <subject>
|
||||
<BLANK LINE>
|
||||
<body>
|
||||
<BLANK LINE>
|
||||
<footer>
|
||||
```
|
||||
|
||||
The **header** is mandatory and the **scope** of the header is optional.
|
||||
|
||||
### 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 <hash>.`, where the hash is the SHA of the commit being reverted.
|
||||
|
||||
### Type
|
||||
|
||||
If the prefix is `feat`, `fix` or `perf`, it will appear in the changelog. However, if there is any [BREAKING CHANGE](#footer), the commit will always appear in the changelog.
|
||||
|
||||
Other prefixes are up to your discretion. Suggested prefixes are `docs`, `chore`, `style`, `refactor`, and `test` for non-changelog related tasks.
|
||||
|
||||
### Scope
|
||||
|
||||
The scope could be anything specifying the place of the commit change. For example `dev`, `build`, `workflow`, `cli` etc...
|
||||
|
||||
### Subject
|
||||
|
||||
The subject contains a succinct description of the change:
|
||||
|
||||
- use the imperative, present tense: "change" not "changed" nor "changes"
|
||||
- don't capitalize the first letter
|
||||
- no dot (.) at the end
|
||||
|
||||
### Body
|
||||
|
||||
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
|
||||
|
||||
### Footer
|
||||
|
||||
The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit **Closes**.
|
||||
|
||||
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
|
||||
5
.github/contributing.md
vendored
Normal file
5
.github/contributing.md
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
# Contributing Guide
|
||||
|
||||
1. Make sure you put things in the right category!
|
||||
2. Always add your items to the end of a list. To be fair, the order is first-come-first-serve.
|
||||
3. If you think something belongs in the wrong category, or think there needs to be a new category, feel free to edit things too.
|
||||
34
.github/pull_request_template.md
vendored
Normal file
34
.github/pull_request_template.md
vendored
Normal file
@@ -0,0 +1,34 @@
|
||||
### `General`
|
||||
|
||||
> ✏️ Mark the necessary items without changing the structure of the PR template.
|
||||
|
||||
- [ ] Pull request template structure not broken
|
||||
|
||||
### `Type`
|
||||
|
||||
> ℹ️ What types of changes does your code introduce?
|
||||
|
||||
> 👉 _Put an `x` in the boxes that apply_
|
||||
|
||||
- [ ] Bug fix (non-breaking change which fixes an issue)
|
||||
- [ ] New feature (non-breaking change which adds functionality)
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
||||
- [ ] This change requires a documentation update
|
||||
|
||||
### `Checklist`
|
||||
|
||||
> ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in [CONTRIBUTING](https://github.com/vuejs/awesome-vue/blob/master/.github/contributing.md).
|
||||
|
||||
> 👉 _Put an `x` in the boxes that apply._
|
||||
|
||||
- [ ] My code follows the style guidelines of this project
|
||||
- [ ] Is the code format correct
|
||||
- [ ] Is the git submission information standard?
|
||||
- [ ] My code follows the style guidelines of this project
|
||||
- [ ] I have performed a self-review of my own code
|
||||
- [ ] I have commented my code, particularly in hard-to-understand areas
|
||||
- [ ] I have made corresponding changes to the documentation
|
||||
- [ ] My changes generate no new warnings
|
||||
- [ ] I have added tests that prove my fix is effective or that my feature works
|
||||
- [ ] New and existing unit tests pass locally with my changes
|
||||
- [ ] Any dependent changes have been merged and published in downstream modules
|
||||
Reference in New Issue
Block a user