Skip to content

Commit 6753a23

Browse files
committed
add readme, issue and pr templates
1 parent 7212483 commit 6753a23

File tree

16 files changed

+484
-137
lines changed

16 files changed

+484
-137
lines changed

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text=auto eol=lf
Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
name: 🐞 Bug report
2+
description: Create a report to help us reproduce and fix the bug
3+
title: "[Bug] "
4+
labels: ['bug']
5+
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Checklist
10+
options:
11+
- label: 1. I have searched related issues but cannot get the expected help.
12+
- label: 2. The bug has not been fixed in the latest version.
13+
- label: 3. I have read [Contributing Guidlines](https://github.com/xing-yiren/course_organization_template/wiki/%F0%9F%A7%AD-Contributing-Guidelines:-Issues-&-Pull-Requests).
14+
- label: 4. Please note that if the bug-related issue you submitted lacks corresponding environment info and a minimal reproducible demo, it will be challenging for us to reproduce and resolve the issue, reducing the likelihood of receiving feedback.
15+
- label: 5. If the issue you raised is not a bug but a question, please raise a discussion at [Discussions](https://github.com/xing-yiren/course_organization_template/discussions/new/choose) Otherwise, it will be closed.
16+
- type: textarea
17+
attributes:
18+
label: Describe the bug
19+
description: |
20+
A clear and concise description of what the bug is, including:
21+
- What happened (actual behavior)
22+
- What you expected (expected outcome)
23+
- **Please attach error logs or screenshots if possible**—this helps us locate the issue faster.
24+
validations:
25+
required: true
26+
- type: textarea
27+
attributes:
28+
label: Reproduction
29+
description: |
30+
What command or script did you run? Please list the exact steps to reproduce the bug.
31+
placeholder: |
32+
A placeholder for the command.
33+
validations:
34+
required: true
35+
- type: checkboxes
36+
id: hardware
37+
attributes:
38+
label: Hardware Environment
39+
description: Which hardware type does this bug relate to (select all that apply)?
40+
options:
41+
- label: Ascend
42+
- label: GPU
43+
- label: CPU
44+
validations:
45+
required: true
46+
- type: input
47+
attributes:
48+
label: OS Platform
49+
description: Which operating system are you using? (e.g., Ubuntu 20.04)
50+
placeholder: "Ubuntu 20.04"
51+
validations:
52+
required: true
53+
- type: input
54+
attributes:
55+
label: Python Version
56+
description: What version of Python are you using? (e.g., 3.9.7)
57+
placeholder: "3.9.7"
58+
validations:
59+
required: true
60+
- type: input
61+
attributes:
62+
label: MindSpore Version
63+
description: What version of MindSpore are you using? (e.g., 2.7.1)
64+
placeholder: "2.7.1"
65+
validations:
66+
required: true
67+
- type: input
68+
id: mindspore_nlp
69+
attributes:
70+
label: (Optional) MindSpore NLP Version
71+
placeholder: e.g., 0.5.0
72+
validations:
73+
required: false
74+
- type: input
75+
id: mindspore_transformers
76+
attributes:
77+
label: (Optional) MindSpore Transformers Version
78+
placeholder: e.g., 1.7.0
79+
validations:
80+
required: false
81+
- type: textarea
82+
id: other_suites
83+
attributes:
84+
label: (Optional) Other Toolkit or Suite Versions
85+
description: |
86+
Specify versions of any other MindSpore-related suites (e.g., MindSpore Lite, vLLM-MindSpore) or relevant third-party packages.
87+
placeholder: |
88+
e.g.,
89+
- MindSpore Lite 2.7.0
90+
- vLLM-MindSpore 0.4.0
91+
validations:
92+
required: false
93+
- type: textarea
94+
attributes:
95+
label: Additional Context
96+
description: Any other details.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: 🚀 Feature request
2+
description: Suggest an idea for this project
3+
title: "[Feature] "
4+
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Checklist
9+
options:
10+
- label: 1. I have read [Contributing Guidlines](https://github.com/xing-yiren/course_organization_template/wiki/%F0%9F%A7%AD-Contributing-Guidelines:-Issues-&-Pull-Requests).
11+
- label: 2. If the issue you raised is not a feature but a question, please raise a discussion at [Discussions](https://github.com/xing-yiren/course_organization_template/discussions/new/choose) Otherwise, it will be closed.
12+
- type: textarea
13+
attributes:
14+
label: Motivation
15+
description: |
16+
A clear and concise description of the motivation of the feature.
17+
validations:
18+
required: true
19+
- type: checkboxes
20+
id: hardware
21+
attributes:
22+
label: Hardware Environment
23+
description: Which hardware does this feature need to support (select all that apply)?
24+
options:
25+
- label: Ascend
26+
- label: GPU
27+
- label: CPU
28+
validations:
29+
required: true
30+
- type: textarea
31+
attributes:
32+
label: Related resources
33+
description: |
34+
If there is an official code release or third-party implementations, please also provide the information here, which would be very helpful.
35+
- type: textarea
36+
attributes:
37+
label: Your Contribution
38+
description: |
39+
Is there any way that you could help, e.g., by submitting a PR?

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!--
2+
Thank you for contributing to this project! 🎉
3+
Please make sure your pull request follows the contribution standards so the review and merge process can go smoothly.
4+
-->
5+
6+
# Description
7+
<!--
8+
Briefly describe the purpose of this PR — what it does, why it’s needed, and which issue(s) it addresses.
9+
Use “Fixes #<issue_number>” if applicable.
10+
-->
11+
12+
# Changes
13+
<!--
14+
Summarize key modifications — new features, bug fixes, refactors, or documentation updates.
15+
-->
16+
17+
# Testing & Benchmark
18+
<!--
19+
If applicable, include test results (e.g., unit tests, accuracy verification, performance benchmarks).
20+
Please attach **logs, screenshots or reports** demonstrating that the code runs successfully and produces the expected results.
21+
-->
22+
23+
# Checklist
24+
25+
- [ ] Read and followed the [Contributing Guidelines](wiki_link).
26+
- [ ] Self-tested locally to ensure the code runs correctly and achieves expected results (all CI checks expected to pass).
27+
- [ ] Updated documentation if needed.
28+
- [ ] Verified accuracy or performance benchmarks if applicable.
29+
30+
# Reviewers
31+
<!--
32+
Please note: each PR must be reviewed by at least **two committers** once all tests have passed.
33+
You may optionally tag members or contributors who might be interested in your PR.
34+
-->

0 commit comments

Comments
 (0)