Skip to content

Commit 01484e6

Browse files
umodocumodoc
committed
项目初始化
0 parents  commit 01484e6

File tree

632 files changed

+70106
-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.

632 files changed

+70106
-0
lines changed

‎.eslintrc

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"root": true,
3+
"extends": [
4+
"plugin:vue/vue3-essential",
5+
"eslint:recommended",
6+
"@vue/eslint-config-prettier/skip-formatting",
7+
],
8+
"parserOptions": {
9+
"ecmaVersion": "latest",
10+
},
11+
"ignorePatterns": ["dist/**"],
12+
"rules": {
13+
"vue/multi-word-component-names": "off",
14+
"no-undef": "off",
15+
"no-unused-vars": "off",
16+
"no-empty": "off",
17+
},
18+
"globals": {
19+
"$ref": "readonly",
20+
"$computed": "readonly",
21+
"$shallowRef": "readonly",
22+
"$customRef": "readonly",
23+
"$toRef": "readonly",
24+
},
25+
}

‎.gitee/CONTRIBUTING

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# 贡献指南
2+
3+
欢迎对本项目做出贡献！请在提交代码之前阅读以下指南。
4+
5+
## 行为准则
6+
7+
本项目遵循 [贡献者公约](https://www.contributor-covenant.org/)。参与项目时，请确保遵守。
8+
9+
## 报告问题
10+
11+
在报告问题之前，请先搜索相关问题是否已经被报告过。如果没有，请提供以下信息：
12+
13+
- 你的操作系统、浏览器、Node.js版本等环境信息
14+
- 详细描述你遇到的问题
15+
- 重现问题的步骤
16+
- 相关截图或错误日志
17+
18+
## 提交拉取请求 (Pull Request)
19+
20+
在提交拉取请求之前，请确保：
21+
22+
- 你已经阅读了 `PULL_REQUEST_TEMPLATE`
23+
- 你的代码遵循了项目中的编码风格
24+
- 你已经添加了必要的单元测试
25+
- 你的更改修复了已知的问题，或者添加了新的功能
26+
27+
### 步骤
28+
29+
1. Fork 仓库
30+
2. 创建一个新的分支 (`git checkout -b feature-branch`)
31+
3. 做出你的更改
32+
4. 提交更改 (`git commit -am '我的更改内容'`)
33+
5. 推送到分支 (`git push origin feature-branch`)
34+
6. 在 Gitee 上创建新的拉取请求
35+
36+
## 代码风格
37+
38+
我们使用 [ESLint](https://eslint.org/) 来保持代码风格一致性，使用 [Prettier](https://prettier.io/) 来格式化代码。请在提交代码之前运行 `npm run lint` 和 `npm run format` 以确保没有风格错误和格式错误。
39+
40+
## 开发指南
41+
42+
- 保持函数简短，并专注于单一职责
43+
- 使用清晰的变量名和函数名
44+
45+
## 沟通
46+
47+
如果你有任何疑问，可以通过以下方式联系我们：
48+
49+
- [Gitee Issues](https://gitee.com/umodoc/editor/issues)
50+
- [联系我们](https://editor.umodoc.com/docs#联系我们)
51+
52+
再次感谢你的贡献！

‎.gitee/ISSUE_TEMPLATE/bug.yml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Bug 反馈
2+
description: 当你在代码中发现了一个 Bug，导致应用崩溃或抛出异常，或者有一个组件存在问题，或者某些地方看起来不对劲。
3+
title: '[Bug]: '
4+
labels: ['bug']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
感谢对项目的支持与关注。在提出问题之前，请确保你已查看相关开发或使用文档：
10+
- https://docs.umodoc.com/
11+
- type: checkboxes
12+
attributes:
13+
label: 这个问题是否已经存在？
14+
options:
15+
- label: 我已经搜索过现有的问题 (https://gitee.com/umodoc/editor/issues)
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: 如何复现
20+
description: 请详细告诉我们如何复现你遇到的问题，如涉及代码，可提供一个最小代码示例，并使用反引号```附上它，或者提供一个 Code Sandbox 或其他在线示例。
21+
placeholder: |
22+
1. ...
23+
2. ...
24+
3. ...
25+
validations:
26+
required: true
27+
- type: textarea
28+
attributes:
29+
label: 预期结果
30+
description: 请告诉我们你预期会发生什么。
31+
validations:
32+
required: true
33+
- type: textarea
34+
attributes:
35+
label: 实际结果
36+
description: 请告诉我们实际发生了什么。
37+
validations:
38+
required: true
39+
- type: textarea
40+
attributes:
41+
label: 截图或视频
42+
description: 如果可以的话，上传任何关于 bug 的截图。
43+
value: |
44+
[在这里上传图片]
45+
- type: dropdown
46+
id: version
47+
attributes:
48+
label: 版本
49+
description: 你当前正在使用我们软件的哪个版本/分支？
50+
validations:
51+
required: true
52+
options:
53+
- 1.0.0

‎.gitee/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Umo Editor 在线文档
4+
url: https://editor.umodoc.com/docs
5+
about: 提供 Umo Editor 使用基本介绍、使用指南、接口说明等
6+
- name: Umo Editor 在线示例
7+
url: https://demo.umodoc.com/editor
8+
about: 提供 Umo Editor 在线示例、基础设置、方法事件、主题设置等

‎.gitee/ISSUE_TEMPLATE/feature.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: 功能建议
2+
description: 对本项目提出一个功能建议
3+
title: '[功能建议]: '
4+
labels: ['enhancement']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
感谢提出功能建议，我们将仔细考虑！
10+
- type: textarea
11+
id: related-problem
12+
attributes:
13+
label: 你的功能建议是否和某个问题相关？
14+
description: 清晰并简洁地描述问题是什么，例如，当我...时，我总是感到困扰。
15+
validations:
16+
required: false
17+
- type: textarea
18+
id: desired-solution
19+
attributes:
20+
label: 你希望看到什么解决方案？
21+
description: 清晰并简洁地描述你希望发生的事情。
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: alternatives
26+
attributes:
27+
label: 你考虑过哪些替代方案？
28+
description: 清晰并简洁地描述你考虑过的任何替代解决方案或功能。
29+
validations:
30+
required: false
31+
- type: textarea
32+
id: additional-context
33+
attributes:
34+
label: 你有其他上下文或截图吗？
35+
description: 在此处添加有关功能请求的任何其他上下文或截图。
36+
validations:
37+
required: false
38+
- type: checkboxes
39+
attributes:
40+
label: 意向参与贡献
41+
options:
42+
- label: 我有意向参与具体功能的开发实现并将代码贡献回到上游社区
43+
required: false

‎.gitee/PULL_REQUEST_TEMPLATE

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# 拉取请求说明
2+
3+
感谢您为项目做出贡献，请填写以下信息以帮助我们审查您的 PR。
4+
5+
## 描述
6+
7+
请简要描述您所做的更改：
8+
9+
- [ ] 我的更改与当前开放的 issue 相关联，或者是一个新功能/修复。
10+
- [ ] 我已经在我的本地环境进行了测试，更改按预期工作。
11+
12+
## 相关问题
13+
14+
请列出此更改解决的 issue 或与之相关的 issue：
15+
16+
- Resolves #issue_number
17+
18+
## 测试计划
19+
20+
请描述您如何测试了您的更改：
21+
22+
- [ ] 我已经在本地运行了单元测试。
23+
- [ ] 我已经在本地运行了集成测试。
24+
- [ ] 我已经在本地运行了性能测试。
25+
26+
## 附加注释
27+
28+
如果有任何其他需要我们知道的信息，请在这里添加：

‎.github/CONTRIBUTING

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# 贡献指南
2+
3+
欢迎对本项目做出贡献！请在提交代码之前阅读以下指南。
4+
5+
## 行为准则
6+
7+
本项目遵循 [贡献者公约](https://www.contributor-covenant.org/)。参与项目时，请确保遵守。
8+
9+
## 报告问题
10+
11+
在报告问题之前，请先搜索相关问题是否已经被报告过。如果没有，请提供以下信息：
12+
13+
- 你的操作系统、浏览器、Node.js版本等环境信息
14+
- 详细描述你遇到的问题
15+
- 重现问题的步骤
16+
- 相关截图或错误日志
17+
18+
## 提交拉取请求 (Pull Request)
19+
20+
在提交拉取请求之前，请确保：
21+
22+
- 你已经阅读了 `PULL_REQUEST_TEMPLATE`
23+
- 你的代码遵循了项目中的编码风格
24+
- 你已经添加了必要的单元测试
25+
- 你的更改修复了已知的问题，或者添加了新的功能
26+
27+
### 步骤
28+
29+
1. Fork 仓库
30+
2. 创建一个新的分支 (`git checkout -b feature-branch`)
31+
3. 做出你的更改
32+
4. 提交更改 (`git commit -am '我的更改内容'`)
33+
5. 推送到分支 (`git push origin feature-branch`)
34+
6. 在 GitHub 上创建新的拉取请求
35+
36+
## 代码风格
37+
38+
我们使用 [ESLint](https://eslint.org/) 来保持代码风格一致性，使用 [Prettier](https://prettier.io/) 来格式化代码。请在提交代码之前运行 `npm run lint` 和 `npm run format` 以确保没有风格错误和格式错误。
39+
40+
## 开发指南
41+
42+
- 保持函数简短，并专注于单一职责
43+
- 使用清晰的变量名和函数名
44+
45+
## 沟通
46+
47+
如果你有任何疑问，可以通过以下方式联系我们：
48+
49+
- [GitHub Issues](https://gitee.com/umodoc/editor/issues)
50+
- [联系我们](https://editor.umodoc.com/docs#联系我们)
51+
52+
再次感谢你的贡献！

‎.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Bug 反馈
2+
description: 当你在代码中发现了一个 Bug，导致应用崩溃或抛出异常，或者有一个组件存在问题，或者某些地方看起来不对劲。
3+
title: '[Bug]: '
4+
labels: ['bug']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
感谢对项目的支持与关注。在提出问题之前，请确保你已查看相关开发或使用文档：
10+
- https://docs.umodoc.com/
11+
- type: checkboxes
12+
attributes:
13+
label: 这个问题是否已经存在？
14+
options:
15+
- label: 我已经搜索过现有的问题 (https://github.com/umodoc/editor/issues)
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: 如何复现
20+
description: 请详细告诉我们如何复现你遇到的问题，如涉及代码，可提供一个最小代码示例，并使用反引号```附上它，或者提供一个 Code Sandbox 或其他在线示例。
21+
placeholder: |
22+
1. ...
23+
2. ...
24+
3. ...
25+
validations:
26+
required: true
27+
- type: textarea
28+
attributes:
29+
label: 预期结果
30+
description: 请告诉我们你预期会发生什么。
31+
validations:
32+
required: true
33+
- type: textarea
34+
attributes:
35+
label: 实际结果
36+
description: 请告诉我们实际发生了什么。
37+
validations:
38+
required: true
39+
- type: textarea
40+
attributes:
41+
label: 截图或视频
42+
description: 如果可以的话，上传任何关于 bug 的截图。
43+
value: |
44+
[在这里上传图片]
45+
- type: dropdown
46+
id: version
47+
attributes:
48+
label: 版本
49+
description: 你当前正在使用我们软件的哪个版本/分支？
50+
validations:
51+
required: true
52+
options:
53+
- 1.0.0

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Umo Editor 在线文档
4+
url: https://editor.umodoc.com/docs
5+
about: 提供 Umo Editor 使用基本介绍、使用指南、接口说明等
6+
- name: Umo Editor 在线示例
7+
url: https://demo.umodoc.com/editor
8+
about: 提供 Umo Editor 在线示例、基础设置、方法事件、主题设置等

‎.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: 功能建议
2+
description: 对本项目提出一个功能建议
3+
title: '[功能建议]: '
4+
labels: ['enhancement']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
感谢提出功能建议，我们将仔细考虑！
10+
- type: textarea
11+
id: related-problem
12+
attributes:
13+
label: 你的功能建议是否和某个问题相关？
14+
description: 清晰并简洁地描述问题是什么，例如，当我...时，我总是感到困扰。
15+
validations:
16+
required: false
17+
- type: textarea
18+
id: desired-solution
19+
attributes:
20+
label: 你希望看到什么解决方案？
21+
description: 清晰并简洁地描述你希望发生的事情。
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: alternatives
26+
attributes:
27+
label: 你考虑过哪些替代方案？
28+
description: 清晰并简洁地描述你考虑过的任何替代解决方案或功能。
29+
validations:
30+
required: false
31+
- type: textarea
32+
id: additional-context
33+
attributes:
34+
label: 你有其他上下文或截图吗？
35+
description: 在此处添加有关功能请求的任何其他上下文或截图。
36+
validations:
37+
required: false
38+
- type: checkboxes
39+
attributes:
40+
label: 意向参与贡献
41+
options:
42+
- label: 我有意向参与具体功能的开发实现并将代码贡献回到上游社区
43+
required: false

0 commit comments

Comments
 (0)