Skip to content

Commit 399334a

Browse files
committed
chore: init project
0 parents  commit 399334a

File tree

630 files changed

+45623
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

630 files changed

+45623
-0
lines changed

.browserslistrc

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
> 1%
2+
last 2 versions
3+
not dead
4+
not ie 11

.changeset/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Changesets
2+
3+
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works with multi-package repos, or single-package repos to help you version and publish your code. You can find the full documentation for it [in our repository](https://github.com/changesets/changesets)
4+
5+
We have a quick list of common questions to get you started engaging with this project in [our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
3+
"changelog": "@changesets/cli/changelog",
4+
"commit": false,
5+
"fixed": [["@vben-core/*", "@vben/*"]],
6+
"snapshot": {
7+
"prereleaseTemplate": "{tag}-{datetime}"
8+
},
9+
"privatePackages": { "version": true, "tag": true },
10+
"linked": [],
11+
"access": "restricted",
12+
"baseBranch": "main",
13+
"updateInternalDependencies": "patch",
14+
"ignore": []
15+
}

.commitlintrc.mjs

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export { default } from '@vben/commitlint-config';

.editorconfig

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
root = true
2+
3+
[*]
4+
charset=utf-8
5+
end_of_line=lf
6+
insert_final_newline=true
7+
indent_style=space
8+
indent_size=2
9+
max_line_length = 100
10+
trim_trailing_whitespace = true
11+
quote_type = single
12+
13+
[*.{yml,yaml,json}]
14+
indent_style = space
15+
indent_size = 2
16+
17+
[*.md]
18+
trim_trailing_whitespace = false
19+
20+
[Makefile]
21+
indent_style = tab

.gitattributes

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# https://docs.github.com/cn/get-started/getting-started-with-git/configuring-git-to-handle-line-endings
2+
3+
# Automatically normalize line endings (to LF) for all text-based files.
4+
* text=auto eol=lf
5+
6+
# Declare files that will always have CRLF line endings on checkout.
7+
*.{cmd,[cC][mM][dD]} text eol=crlf
8+
*.{bat,[bB][aA][tT]} text eol=crlf
9+
10+
# Denote all files that are truly binary and should not be modified.
11+
*.{ico,png,jpg,jpeg,gif,webp,svg,woff,woff2} binary

.gitconfig

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[core]
2+
ignorecase = false

.github/ISSUE_TEMPLATE/1-bug.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: 🐛 Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: 'bug: pending triage'
6+
assignees: ''
7+
---
8+
9+
<!--
10+
抱歉,您遇到了一个错误。感谢您抽出宝贵的时间进行举报!
11+
12+
请尽可能填写以下模板。
13+
14+
Ouch, sorry you’ve run into a bug. Thank for taking the time to report it!
15+
16+
Please fill in as much of the template below as you’re able.
17+
18+
P.S. have you seen our support and contributing docs?
19+
-->
20+
21+
**⚠️ IMPORTANT ⚠️ Please check the following list before proceeding. If you ignore this issue template, your issue will be directly closed.**
22+
23+
- [ ] Read [the docs](https://anncwb.github.io/vue-vben-admin-doc/).
24+
- [ ] Make sure the code is up to date. (Some bugs have been fixed in the latest code)
25+
- [ ] This is a concrete bug. For Q&A open a [GitHub Discussion](https://github.com/anncwb/vue-vben-admin/discussions) or join our [Discord](https://discord.gg/8GuAdwDhj6) Chat Server.
26+
27+
### Describe the bug
28+
29+
A clear and concise description of what the bug is..
30+
31+
### Reproduction
32+
33+
Please describe the steps of the problem in detail to ensure that we can restore the correct problem
34+
35+
## System Info
36+
37+
- Operating System:
38+
- Node version:
39+
- Package manager (npm/yarn/pnpm) and version:

.github/ISSUE_TEMPLATE/2-feature.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: 🚀 Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
<!--
10+
感谢您提出使这个项目更好的想法!
11+
请尽可能填写以下模板。
12+
13+
Thank you for suggesting an idea to make this project better!
14+
Please fill in as much of the template below as you’re able.
15+
16+
-->
17+
18+
### Subject of the feature
19+
20+
Describe your issue here.
21+
22+
### Problem
23+
24+
If the feature requests relates to a problem, please describe the problem you are trying to solve here.
25+
26+
### Expected behaviour
27+
28+
What should happen? Please describe the desired behaviour.
29+
30+
### Alternatives
31+
32+
What are the alternative solutions? Please describe what else you have considered?

.github/ISSUE_TEMPLATE/3-bug-cn.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: 🐛 Bug 报告
3+
about: 向我们报告一个Bug以帮助我们改进
4+
title: ''
5+
labels: 'bug: pending triage'
6+
assignees: ''
7+
---
8+
9+
**⚠️ 重要 ⚠️ 在进一步操作之前,请检查下列选项。如果您忽视此模板或者没有提供关键信息,您的 Issue 将直接被关闭**
10+
11+
- [ ] 已阅读 [文档](https://anncwb.github.io/vue-vben-admin-doc/).
12+
- [ ] 确保您的代码已是最新或者所报告的 Bug 在最新版本中可以重现. (部分 Bug 可能已经在最近的代码中修复)
13+
- [ ] 已在 Issues 中搜索了相关的关键词
14+
- [ ] 不是 ant design vue 组件库的 Bug
15+
16+
### 描述 Bug
17+
18+
请清晰地描述此 Bug 的具体表现。
19+
20+
### 复现 Bug
21+
22+
请描述在演示页面中复现 Bug 的详细步骤,以确保我们可以理解并定位问题。部分 Bug 如果未在 Demo 中涉及,请务必提供关键代码
23+
24+
## 系统信息
25+
26+
- 操作系统:
27+
- Node 版本:
28+
- 包管理器 (npm/yarn/pnpm) 及其版本:

.github/ISSUE_TEMPLATE/config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Discord Chat
4+
url: https://discord.gg/8GuAdwDhj6
5+
about: Ask questions and discuss with other Vben users in real time.
6+
- name: Questions & Discussions
7+
url: https://github.com/anncwb/vue-vben-admin/discussions
8+
about: Use GitHub discussions for message-board style questions and discussions.

.github/commit-convention.md

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
## Git Commit Message Convention
2+
3+
> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).
4+
5+
#### TL;DR:
6+
7+
Messages must be matched by the following regex:
8+
9+
```js
10+
/^(revert: )?(feat|fix|docs|style|refactor|perf|test|workflow|build|ci|chore|types|wip): .{1,50}/;
11+
```
12+
13+
#### Examples
14+
15+
Appears under "Features" header, `dev` subheader:
16+
17+
```
18+
feat(dev): add 'comments' option
19+
```
20+
21+
Appears under "Bug Fixes" header, `dev` subheader, with a link to issue #28:
22+
23+
```
24+
fix(dev): fix dev error
25+
26+
close #28
27+
```
28+
29+
Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:
30+
31+
```
32+
perf(build): remove 'foo' option
33+
34+
BREAKING CHANGE: The 'foo' option has been removed.
35+
```
36+
37+
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.
38+
39+
```
40+
revert: feat(compiler): add 'comments' option
41+
42+
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
43+
```
44+
45+
### Full Message Format
46+
47+
A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:
48+
49+
```
50+
<type>(<scope>): <subject>
51+
<BLANK LINE>
52+
<body>
53+
<BLANK LINE>
54+
<footer>
55+
```
56+
57+
The **header** is mandatory and the **scope** of the header is optional.
58+
59+
### Revert
60+
61+
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.
62+
63+
### Type
64+
65+
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.
66+
67+
Other prefixes are up to your discretion. Suggested prefixes are `docs`, `chore`, `style`, `refactor`, and `test` for non-changelog related tasks.
68+
69+
### Scope
70+
71+
The scope could be anything specifying the place of the commit change. For example `dev`, `build`, `workflow`, `cli` etc...
72+
73+
### Subject
74+
75+
The subject contains a succinct description of the change:
76+
77+
- use the imperative, present tense: "change" not "changed" nor "changes"
78+
- don't capitalize the first letter
79+
- no dot (.) at the end
80+
81+
### Body
82+
83+
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.
84+
85+
### Footer
86+
87+
The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit **Closes**.
88+
89+
**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.

.github/contributing.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Contributing Guide
2+
3+
1. Make sure you put things in the right category!
4+
2. Always add your items to the end of a list. To be fair, the order is first-come-first-serve.
5+
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.

.github/pull_request_template.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
### `General`
2+
3+
> ✏️ Mark the necessary items without changing the structure of the PR template.
4+
5+
- [ ] Pull request template structure not broken
6+
7+
### `Type`
8+
9+
> ℹ️ What types of changes does your code introduce?
10+
11+
> 👉 _Put an `x` in the boxes that apply_
12+
13+
- [ ] Bug fix (non-breaking change which fixes an issue)
14+
- [ ] New feature (non-breaking change which adds functionality)
15+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
16+
- [ ] This change requires a documentation update
17+
18+
### `Checklist`
19+
20+
> ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in [CONTRIBUTING](contributing.md).
21+
22+
> 👉 _Put an `x` in the boxes that apply._
23+
24+
- [ ] My code follows the style guidelines of this project
25+
- [ ] Is the code format correct
26+
- [ ] Is the git submission information standard?
27+
- [ ] My code follows the style guidelines of this project
28+
- [ ] I have performed a self-review of my own code
29+
- [ ] I have commented my code, particularly in hard-to-understand areas
30+
- [ ] I have made corresponding changes to the documentation
31+
- [ ] My changes generate no new warnings
32+
- [ ] I have added tests that prove my fix is effective or that my feature works
33+
- [ ] New and existing unit tests pass locally with my changes
34+
- [ ] Any dependent changes have been merged and published in downstream modules

0 commit comments

Comments
 (0)