Skip to content

Commit 03e9aa2

Browse files
KashiwaByte101KashiwaByte101
authored
docs:github Issue and PR template (#17)
1 parent 78cf03a commit 03e9aa2

File tree

5 files changed

+142
-0
lines changed

5 files changed

+142
-0
lines changed

‎.github/ISSUE_TEMPLATE/01_bug_report.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
name: "🐛 Bug Report"
3+
description: "Create a report to help us improve"
4+
title: "[BUG]: "
5+
labels: ["bug"]
6+
assignees: ""
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: "<!-- Describe your bugs below ^_^ -->"
11+
- type: textarea
12+
id: bug-description
13+
attributes:
14+
label: "🐛 Bug description [Please make everyone to understand it]"
15+
description: "Describe the main elements of the bug"
16+
placeholder: "Please provide a clear and detailed description of the bug..."
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: steps-to-reproduce
21+
attributes:
22+
label: "🧑‍💻 Step to reproduce"
23+
description: "Describe the steps to reproduce the behavior"
24+
placeholder: |
25+
1. Go to '...'
26+
2. Click on '...'
27+
3. Scroll down to '...'
28+
4. See error
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: expected-result
33+
attributes:
34+
label: "👾 Expected result"
35+
description: "Write down the results you expect"
36+
placeholder: "I expected that..."
37+
validations:
38+
required: true
39+
- type: textarea
40+
id: additional-info
41+
attributes:
42+
label: "🚑 Any additional information"
43+
description: "Add any other context, screenshots, or system information here"
44+
placeholder: "Screenshots, error logs, or other relevant information..."
45+
- type: input
46+
id: version
47+
attributes:
48+
label: "MineContext Version"
49+
description: "What version of MineContext are you using?"
50+
placeholder: "e.g., 0.1.0"
51+
- type: textarea
52+
id: platform
53+
attributes:
54+
label: "Platform Details"
55+
description: "Please specify your platform, OS version, and any other relevant system information"
56+
placeholder: |
57+
Operating System:
58+
Version:
59+
Additional Details:
60+
validations:
61+
required: true
62+
---

‎.github/ISSUE_TEMPLATE/02_feature_advice.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: "🏠 Feature Advice"
3+
description: "Suggest an idea for this project"
4+
title: "[ADVICE]: "
5+
labels: ["advice"]
6+
assignees: ""
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: "## 🤪 Features description [Please make everyone to understand it]"
11+
- type: textarea
12+
id: feature-description
13+
attributes:
14+
label: "Feature Description"
15+
description: "Briefly describe this feature"
16+
placeholder: "Please provide a clear and concise description of the feature suggestion..."
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: problem-solution
21+
attributes:
22+
label: "👍 What problem does this feature solve"
23+
description: "Explain what problem or pain point this feature would address"
24+
placeholder: "This feature would solve..."
25+
- type: textarea
26+
id: proposed-api
27+
attributes:
28+
label: "👾 What does the proposed API look like"
29+
description: "If applicable, describe how the API or interface would work"
30+
placeholder: "The proposed API would include..."
31+
- type: textarea
32+
id: additional-info
33+
attributes:
34+
label: "🚑 Any additional information"
35+
description: "Add any other context, screenshots, or examples here"
36+
placeholder: "Screenshots, mockups, or additional context..."
37+
---

‎.github/ISSUE_TEMPLATE/03_docs_advice.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: "📚 Documentation Improvement"
3+
description: "Suggest improvements or report errors in documentation"
4+
title: "[Docs]: "
5+
labels: ["documentation"]
6+
body:
7+
- type: textarea
8+
id: doc-location
9+
attributes:
10+
label: "Documentation Location"
11+
description: "Please provide the URL or path to the relevant documentation."
12+
- type: textarea
13+
id: current-content
14+
attributes:
15+
label: "Issue with Current Content"
16+
description: "What's the problem with the current documentation? Is it incorrect, unclear, or missing?"
17+
- type: textarea
18+
id: suggested-improvement
19+
attributes:
20+
label: "Suggested Improvement"
21+
description: "How do you think it should be modified?"
22+
---

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Get community support
4+
url: https://bytedance.larkoffice.com/wiki/Hg6VwrxnTiXtWUkgHexcFTqrnpg
5+
about: Post your question where experienced developers can offer assistance

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Description
2+
3+
Please include a concise summary, in clear English, of the changes in this pull request. If it closes an issue, please
4+
mention it here.
5+
6+
Closes: #(issue)
7+
8+
## 🎯 PRs Should Target Issues
9+
10+
Before your create a PR, please check to see if there is [an existing issue](https://github.com/volcengine/MineContext/issues)
11+
for this change. If not, please create an issue before you create this PR, unless the fix is very small.
12+
13+
Not adhering to this guideline will result in the PR being closed.
14+
15+
<!-- ## Tests -->
16+
<!-- There are no hive tests yet -->

0 commit comments

Comments
 (0)