Keldos commited on
Commit
b6c84da
·
1 Parent(s): a2ba1c0

doc: 增补pr模板和issue模板,新增contributing

Browse files
.github/CONTRIBUTING.md ADDED
@@ -0,0 +1,49 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # 如何做出贡献
2
+
3
+ 感谢您对 川虎ChatGPT 的关注!感谢您投入时间为我们的项目做出贡献!
4
+
5
+ 在开始之前,您可以阅读我们的以下简短提示。更多信息您可以点击链接查阅。
6
+
7
+ ## GitHub 新手?
8
+
9
+ 以下是 GitHub 的一些资源,如果您是GitHub新手,它们可帮助您开始为开源项目做贡献:
10
+
11
+ - [GitHub上为开源做出贡献的方法](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
12
+ - [设置Git](https://docs.github.com/en/get-started/quickstart/set-up-git)
13
+ - [GitHub工作流](https://docs.github.com/en/get-started/quickstart/github-flow)
14
+ - [使用拉取请求](https://docs.github.com/en/github/collaborating-with-pull-requests)
15
+
16
+ ## 提交 Issues
17
+
18
+ 是的!提交ISSUE其实是您为项目做出贡献的一种方式!但需要您提出合理的ISSUE才是对项目有帮助的。
19
+
20
+ 我们的[常见问题](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/常见问题)中描述了您应当怎样提出一个不重复的ISSUE,以及什么情况应当提ISSUE,什么情况应当在讨论区发问。
21
+
22
+ **请注意,ISSUE不是项目的评论区。**
23
+
24
+ > **Note**
25
+ >
26
+ > 另外,请注意“问题”一词表示“question”和“problem”的区别。
27
+ > 如果您需要报告项目本身实际的技术问题、故障或错误(problem),那么欢迎提交一个新的 issue。但是,如果您只是碰到了一些自己无法解决的问题需要向其他用户或我们提问(question),那么最好的选择是在讨论区中发布一个新的帖子。 如果您不确定,请首先考虑在讨论区提问。
28
+ >
29
+ > 目前,我们默认了您发在 issue 中的问题是一个 question,但我们希望避免再在 issue 中见到类似“我该怎么操作?”的提问QAQ。
30
+
31
+ ## 提交 Pull Request
32
+
33
+ 如果您具备一定能力,您可以修改本项目的源代码,并提交一个 pull request!合并之后,您的名字将会出现在 CONTRIBUTORS 中~
34
+
35
+ 我们的[贡献指南](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/贡献指南)详细地写出了您每一步应当做什么~ 如果您希望提交源代码的更改,快去看看吧~
36
+
37
+ > **Note**
38
+ >
39
+ > 我们不会强制要求您符合我们的规范,但希望您可以减轻我们的工作。
40
+
41
+ ## 参与讨论
42
+
43
+ 讨论区是我们进行对话的地方。
44
+
45
+ 如果您想帮助有一个很棒的新想法,或者想分享您的使用技巧,请加入我们的讨论(Discussion)!同时,许多用户会在讨论区提出他们的疑问,如果您能为他们提供解答,我们也将无比感激!
46
+
47
+ -----
48
+
49
+ 再次感谢您看到这里!感谢您为我们项目做出的贡献!
.github/ISSUE_TEMPLATE/feature-request.yml CHANGED
@@ -23,7 +23,8 @@ body:
23
  - type: checkboxes
24
  attributes:
25
  label: 帮助开发
26
- description: 如果您能帮助开发并提交一个pull request,那再好不过了!
 
27
  options:
28
  - label: 我愿意协助开发!
29
  required: false
 
23
  - type: checkboxes
24
  attributes:
25
  label: 帮助开发
26
+ description: 如果您能帮助开发并提交一个pull request,那再好不过了!<br />
27
+ 参考:[贡献指南](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/贡献指南)
28
  options:
29
  - label: 我愿意协助开发!
30
  required: false
.github/ISSUE_TEMPLATE/report-bug.yml CHANGED
@@ -15,9 +15,9 @@ body:
15
  - type: checkboxes
16
  attributes:
17
  label: 这个bug是否已存在现有issue了?
18
- description: 请搜索以查看您想报告的issue是否已存在。
19
  options:
20
- - label: 我确认没有已有issue
21
  required: true
22
  - type: textarea
23
  id: what-happened
@@ -49,7 +49,7 @@ body:
49
  attributes:
50
  label: 运行环境
51
  description: |
52
- 以下是一个例子:
53
  - **OS**: Windows11 22H2
54
  - **Browser**: Chrome
55
  - **Gradio version**: 3.22.1
@@ -59,9 +59,16 @@ body:
59
  - Browser:
60
  - Gradio version:
61
  - Python version:
62
- render: markdown
63
  validations:
64
  required: false
 
 
 
 
 
 
 
 
65
  - type: textarea
66
  attributes:
67
  label: 补充说明
 
15
  - type: checkboxes
16
  attributes:
17
  label: 这个bug是否已存在现有issue了?
18
+ description: 请搜索全部issue和[常见问题](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/常见问题)以查看您想报告的issue是否已存在。
19
  options:
20
+ - label: 我确认没有已有issue,且已阅读**常见问题**。
21
  required: true
22
  - type: textarea
23
  id: what-happened
 
49
  attributes:
50
  label: 运行环境
51
  description: |
52
+ 网页底部会列出您运行环境的版本信息,请务必填写。以下是一个例子:
53
  - **OS**: Windows11 22H2
54
  - **Browser**: Chrome
55
  - **Gradio version**: 3.22.1
 
59
  - Browser:
60
  - Gradio version:
61
  - Python version:
 
62
  validations:
63
  required: false
64
+ - type: checkboxes
65
+ attributes:
66
+ label: 帮助解决
67
+ description: 如果您能够并愿意协助解决该问题,向我们提交一个pull request,那再好不过了!<br />
68
+ 参考:[贡献指南](https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/贡献指南)
69
+ options:
70
+ - label: 我愿意协助解决!
71
+ required: false
72
  - type: textarea
73
  attributes:
74
  label: 补充说明
.github/ISSUE_TEMPLATE/report-docker.yml CHANGED
@@ -1,7 +1,7 @@
1
- name: 服务器部署错误
2
- description: "报告在远程服务器上部署时的问题或错误"
3
- title: "[远程部署]: "
4
- labels: ["question","server deployment"]
5
  body:
6
  - type: markdown
7
  attributes:
@@ -55,8 +55,8 @@ body:
55
  attributes:
56
  label: 运行环境
57
  description: |
58
- 以下是一个例子:
59
- - **OS**: Windows11 22H2
60
  - **Docker version**: 1.8.2
61
  - **Gradio version**: 3.22.1
62
  - **Python version**: 3.11.1
@@ -65,7 +65,6 @@ body:
65
  - Docker version:
66
  - Gradio version:
67
  - Python version:
68
- render: markdown
69
  validations:
70
  required: false
71
  - type: textarea
 
1
+ name: Docker部署错误
2
+ description: "报告使用 Docker 部署时的问题或错误"
3
+ title: "[Docker]: "
4
+ labels: ["question","docker deployment"]
5
  body:
6
  - type: markdown
7
  attributes:
 
55
  attributes:
56
  label: 运行环境
57
  description: |
58
+ 网页底部会列出您运行环境的版本信息,请务必填写。以下是一个例子:
59
+ - **OS**: Linux/amd64
60
  - **Docker version**: 1.8.2
61
  - **Gradio version**: 3.22.1
62
  - **Python version**: 3.11.1
 
65
  - Docker version:
66
  - Gradio version:
67
  - Python version:
 
68
  validations:
69
  required: false
70
  - type: textarea
.github/ISSUE_TEMPLATE/report-localhost.yml CHANGED
@@ -57,17 +57,11 @@ body:
57
  attributes:
58
  label: 运行环境
59
  description: |
60
- 以下是一个例子:
61
  - **OS**: Windows11 22H2
62
  - **Browser**: Chrome
63
  - **Gradio version**: 3.22.1
64
  - **Python version**: 3.11.1
65
-
66
- 提示:你可以在终端中依次输入以下指令以查看gradio和python的版本:
67
- ```shell
68
- pip show gradio
69
- python3 --version
70
- ```
71
  value: |
72
  - OS:
73
  - Browser:
 
57
  attributes:
58
  label: 运行环境
59
  description: |
60
+ 网页底部会列出您运行环境的版本信息,请务必填写。以下是一个例子:
61
  - **OS**: Windows11 22H2
62
  - **Browser**: Chrome
63
  - **Gradio version**: 3.22.1
64
  - **Python version**: 3.11.1
 
 
 
 
 
 
65
  value: |
66
  - OS:
67
  - Browser:
.github/ISSUE_TEMPLATE/report-others.yml CHANGED
@@ -48,7 +48,7 @@ body:
48
  attributes:
49
  label: 运行环境
50
  description: |
51
- 以下是一个例子:
52
  - **OS**: Windows11 22H2
53
  - **Browser**: Chrome
54
  - **Gradio version**: 3.22.1
@@ -59,7 +59,6 @@ body:
59
  - Gradio version:
60
  - Python version:
61
  (或您的其他运行环境信息)
62
- render: markdown
63
  validations:
64
  required: false
65
  - type: textarea
 
48
  attributes:
49
  label: 运行环境
50
  description: |
51
+ 网页底部会列出您运行环境的版本信息,请务必填写。以下是一个例子:
52
  - **OS**: Windows11 22H2
53
  - **Browser**: Chrome
54
  - **Gradio version**: 3.22.1
 
59
  - Gradio version:
60
  - Python version:
61
  (或您的其他运行环境信息)
 
62
  validations:
63
  required: false
64
  - type: textarea
.github/ISSUE_TEMPLATE/report-server.yml CHANGED
@@ -1,7 +1,7 @@
1
- name: Docker部署错误
2
- description: "报告使用 Docker 部署时的问题或错误"
3
- title: "[Docker]: "
4
- labels: ["question","docker deployment"]
5
  body:
6
  - type: markdown
7
  attributes:
@@ -55,17 +55,16 @@ body:
55
  attributes:
56
  label: 运行环境
57
  description: |
58
- 以下是一个例子:
59
- - **OS**: Linux/amd64
60
- - **Browser**: Chrome
61
  - **Gradio version**: 3.22.1
62
  - **Python version**: 3.11.1
63
  value: |
64
  - OS:
65
- - Browser:
66
  - Gradio version:
67
  - Python version:
68
- render: markdown
69
  validations:
70
  required: false
71
  - type: textarea
 
1
+ name: 服务器部署错误
2
+ description: "报告在远程服务器上部署时的问题或错误"
3
+ title: "[远程部署]: "
4
+ labels: ["question","server deployment"]
5
  body:
6
  - type: markdown
7
  attributes:
 
55
  attributes:
56
  label: 运行环境
57
  description: |
58
+ 网页底部会列出您运行环境的版本信息,请务必填写。以下是一个例子:
59
+ - **OS**: Windows11 22H2
60
+ - **Docker version**: 1.8.2
61
  - **Gradio version**: 3.22.1
62
  - **Python version**: 3.11.1
63
  value: |
64
  - OS:
65
+ - Server:
66
  - Gradio version:
67
  - Python version:
 
68
  validations:
69
  required: false
70
  - type: textarea
.github/pull_request_template.md ADDED
@@ -0,0 +1,31 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!--
2
+ 这是一个拉取请求模板。本文段处于注释中,请您先查看本注释,在您提交时该段文字将不会显示。
3
+
4
+ 1. 在提交拉取请求前,您最好已经查看过:https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/贡献指南 了解了我们的大致要求;
5
+ 2. 如果您的这一个pr包含多个不同的功能添加或问题修复,请务必将您的提交拆分为多个不同的原子化的commit,甚至您可以在不同的分支中提交多个pull request;
6
+ 3. 不过,就算您的提交与pr写得完全不合规范也没有关系,您可以直接提交,我们会进行审查。总之我们欢迎您做出贡献!
7
+
8
+ 您可以参考这个示例 pull request:[#439](https://github.com/GaiZhenbiao/ChuanhuChatGPT/pull/439)
9
+ -->
10
+
11
+ ### 描述
12
+
13
+ 描述您的pull request所做的更改。
14
+ 另外请附上相关程序运行时的截图(before & after),以直观地展现您的更改达成的效果。
15
+
16
+ ### 相关问题
17
+
18
+ (如有)请列出与此拉取请求相关的issue。
19
+ 或者,您可以直接描述您的工作能解决的问题等。
20
+
21
+ ### 补充信息
22
+
23
+ 请提供任何其他信息或说明,有助于其他贡献者理解您的更改。
24
+
25
+ 如果您提交的是 draft pull request,也请在这里写明开发进度。例子:
26
+
27
+ #### 开发进度
28
+
29
+ - [x] 已经做好的事情1
30
+ - [ ] 还要干的事情1
31
+ - [ ] 还要干的事情2