Skip to content

Commit b8cfc97

Browse files
521xueweihan521xueweihan
committed
update ISSUE_TEMPLATE
1 parent 27b78f4 commit b8cfc97

File tree

4 files changed

+229
-43
lines changed

4 files changed

+229
-43
lines changed

‎.github/ISSUE_TEMPLATE.md

-43
This file was deleted.

‎.github/ISSUE_TEMPLATE/config.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Website Submit Project
4+
url: https://hellogithub.com/
5+
about: Go website to submit an open-source project

‎.github/ISSUE_TEMPLATE/submit-cn.yaml

+112
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
name: "提交项目"
2+
description: "提交一个开源项目"
3+
title: "[开源推荐] "
4+
assignees:
5+
- "521xueweihan"
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
## 推荐项目
12+
13+
这里是 HelloGitHub 月刊推荐项目的入口，欢迎自荐和推荐开源项目，唯一要求：请按照下面的提示介绍项目。
14+
15+
- type: input
16+
id: project_url
17+
attributes:
18+
label: "项目地址"
19+
description: "仅收录 GitHub 上的开源项目，请填写 GitHub 的项目地址"
20+
placeholder: "https://github.com/username/repo"
21+
validations:
22+
required: true
23+
24+
- type: dropdown
25+
id: category
26+
attributes:
27+
label: "类别"
28+
description: "请选择项目的类别"
29+
options:
30+
- C
31+
- C#
32+
- C++
33+
- CSS
34+
- Go
35+
- Java
36+
- JS
37+
- Kotlin
38+
- Objective-C
39+
- PHP
40+
- Python
41+
- Ruby
42+
- Rust
43+
- Swift
44+
- 其它
45+
- 书籍
46+
- 人工智能
47+
validations:
48+
required: true
49+
50+
- type: input
51+
id: project_title
52+
attributes:
53+
label: "项目标题"
54+
description: "请用 20 个左右的字描述它是做什么的，类似文章标题让人一目了然"
55+
placeholder: "例如：一个帮助初学者入门Python的教程项目"
56+
validations:
57+
required: true
58+
max_length: 50
59+
60+
- type: textarea
61+
id: project_description
62+
attributes:
63+
label: "项目描述"
64+
description: "这是个什么项目、能用来干什么、有什么特点或解决了什么痛点，适用于什么场景、能够让初学者学到什么。长度 32-256 字符"
65+
placeholder: "例如：这是一个Python入门教程，帮助零基础的初学者快速学习Python基础语法和编程思维。"
66+
validations:
67+
required: true
68+
min_length: 32
69+
max_length: 256
70+
71+
- type: textarea
72+
id: project_highlights
73+
attributes:
74+
label: "亮点"
75+
description: "令人眼前一亮的点是什么？类比同类型项目有什么特点！"
76+
placeholder: "例如：每个知识点都配备了生动的实例，降低了学习门槛。"
77+
validations:
78+
required: true
79+
80+
- type: textarea
81+
id: example_code
82+
attributes:
83+
label: "示例代码"
84+
description: "可选，提供项目的示例代码"
85+
placeholder: "例如：\n```python\nprint('Hello, world!')\n```"
86+
render: markdown
87+
validations:
88+
required: false
89+
90+
- type: textarea
91+
id: project_screenshot
92+
attributes:
93+
label: "截图或演示视频"
94+
description: "可选，请直接上传图片或演示视频文件，也可以粘贴外部链接"
95+
placeholder: "在此处粘贴图片或视频链接，或直接拖拽上传"
96+
validations:
97+
required: false
98+
99+
- type: markdown
100+
attributes:
101+
value: |
102+
## 提高项目收录的方法
103+
104+
1. **请勿使用复制的内容**作为项目描述提交！
105+
106+
2. 到 [HelloGitHub网站](https://hellogithub.com) 搜索要推荐的项目地址，查看准备推荐的项目**是否被推荐过**。
107+
108+
3. 根据 [项目审核标准说明](https://github.com/521xueweihan/HelloGitHub/issues/271) 修改项目。
109+
110+
如您推荐的项目收录到《HelloGitHub》月刊，您的 GitHub 帐号将展示在 [贡献人列表](https://github.com/521xueweihan/HelloGitHub/blob/master/content/contributors.md)，**同时会在本 issue 中通知您**。
111+
112+
最后，感谢您对 HelloGitHub 项目的支持！

‎.github/ISSUE_TEMPLATE/submit-en.yaml

+112
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
name: "Submit Project"
2+
description: "Submit an open-source project"
3+
title: "[Open Source] "
4+
assignees:
5+
- "521xueweihan"
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
## Project Recommendation
12+
13+
This is the entry point for recommending open-source projects to HelloGitHub Monthly. You're welcome to recommend your own projects or other great open-source projects. Please follow the prompts below to describe your project.
14+
15+
- type: input
16+
id: project_url
17+
attributes:
18+
label: "Project URL"
19+
description: "Only open-source projects hosted on GitHub are accepted. Please provide the GitHub repository URL."
20+
placeholder: "https://github.com/username/repo"
21+
validations:
22+
required: true
23+
24+
- type: dropdown
25+
id: category
26+
attributes:
27+
label: "Category"
28+
description: "Please select the project's category"
29+
options:
30+
- C
31+
- C#
32+
- C++
33+
- CSS
34+
- Go
35+
- Java
36+
- JS
37+
- Kotlin
38+
- Objective-C
39+
- PHP
40+
- Python
41+
- Ruby
42+
- Rust
43+
- Swift
44+
- Other
45+
- Books
46+
- Machine Learning
47+
validations:
48+
required: true
49+
50+
- type: input
51+
id: project_title
52+
attributes:
53+
label: "Project Title"
54+
description: "Briefly summarize the project in about 20 words, like a clear article headline."
55+
placeholder: "e.g., A tutorial project helping beginners learn Python"
56+
validations:
57+
required: true
58+
max_length: 50
59+
60+
- type: textarea
61+
id: project_description
62+
attributes:
63+
label: "Project Description"
64+
description: "What is this project about? What can it do? What special features or pain points does it address? What scenarios is it suitable for, and what can beginners learn from it? (32-256 characters)"
65+
placeholder: "e.g., This is a beginner-friendly Python tutorial that helps people with zero programming experience quickly grasp basic Python syntax and programming concepts."
66+
validations:
67+
required: true
68+
min_length: 32
69+
max_length: 256
70+
71+
- type: textarea
72+
id: project_highlights
73+
attributes:
74+
label: "Highlights"
75+
description: "What makes this project stand out? How does it differ from similar projects?"
76+
placeholder: "e.g., Each topic comes with vivid and easy-to-understand examples, lowering the learning barrier."
77+
validations:
78+
required: true
79+
80+
- type: textarea
81+
id: example_code
82+
attributes:
83+
label: "Example Code"
84+
description: "Optional. Provide example code snippets from the project."
85+
placeholder: "e.g.,\n```python\nprint('Hello, world!')\n```"
86+
render: markdown
87+
validations:
88+
required: false
89+
90+
- type: textarea
91+
id: project_screenshot
92+
attributes:
93+
label: "Screenshots or Demo Videos"
94+
description: "Optional. You can directly upload image or video files, or paste external links."
95+
placeholder: "Paste image or video links here, or drag files directly to upload."
96+
validations:
97+
required: false
98+
99+
- type: markdown
100+
attributes:
101+
value: |
102+
## Tips for Improving Project Acceptance
103+
104+
1. **Do not use copied content** as your project description.
105+
106+
2. Visit [HelloGitHub website](https://hellogithub.com) to search for the project URL you're recommending to verify if it has already been recommended.
107+
108+
3. Adjust your submission according to the [Project Review Guidelines](https://github.com/521xueweihan/HelloGitHub/issues/271).
109+
110+
If your recommended project is included in HelloGitHub Monthly, your GitHub username will appear in the [contributors list](https://github.com/521xueweihan/HelloGitHub/blob/master/content/contributors.md), **and you'll be notified in this issue**.
111+
112+
Thank you for supporting the HelloGitHub project!

0 commit comments

Comments
 (0)