Skip to content

Commit 67a30f2

Browse files
njzjz-botCopilotpre-commit-ci[bot]njzjz
authored
docs(discussions): add lightweight q-and-a discussion template (#5385)
Problem - The previous discussion-template proposal in #4902 used an invalid GitHub Discussions form schema, so it could not be used as-is. - Based on review feedback, the discussion template should be much lighter-weight and focused on Q&A only. Change - add a single lightweight Q&A discussion form at `.github/DISCUSSION_TEMPLATE/q-a.yml` - make most technical fields optional and explicitly ask users to fill them only when relevant - align field names with the existing issue templates where practical - document the discussion-template slug/schema constraints in `.github/DISCUSSION_TEMPLATE/README.md` - keep the documentation changes that were already part of #4902 Notes - This PR supersedes #4902. - The discussion form filename now matches the category slug (`q-a.yml`), and the top-level schema uses supported keys only. Authored by OpenClaw (model: gpt-5.4) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added a new Q&A discussion template for GitHub Discussions with structured form fields to capture technical questions, environment details, versions, and reproducible examples. * Added documentation describing available discussion templates and usage guidelines for community contributions. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
1 parent 80fc539 commit 67a30f2

File tree

2 files changed

+105
-0
lines changed

2 files changed

+105
-0
lines changed
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Discussion Templates
2+
3+
This directory contains GitHub Discussion category forms for DeePMD-kit.
4+
5+
## Active template
6+
7+
- `q-a.yml`**Q&A**
8+
9+
## Notes
10+
11+
- The filename must match the discussion category slug exactly.
12+
- GitHub Discussion forms only support a limited set of top-level keys, such as `title`, `labels`, and `body`.
13+
- This Q&A template is intentionally lightweight; most fields are optional and should be filled only when relevant.
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
title: "[Q&A] "
2+
labels: ["question"]
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Use this form for Q&A discussions.
8+
9+
This template is intentionally lightweight.
10+
**Only fill the technical fields below if they are relevant to your question.**
11+
12+
If your question is about using DeePMD-kit or diagnosing a problem, version info and a minimal reproducible example can help others answer faster.
13+
- type: textarea
14+
id: question
15+
attributes:
16+
label: Question
17+
description: Please describe your question clearly.
18+
placeholder: What would you like to ask?
19+
value:
20+
validations:
21+
required: true
22+
- type: input
23+
id: version
24+
attributes:
25+
label: DeePMD-kit Version
26+
description: "If applicable: `dp --version`."
27+
placeholder: "e.g., 2.2.7"
28+
validations:
29+
required: false
30+
- type: input
31+
id: backend-version
32+
attributes:
33+
label: Backend and its version
34+
description: "If applicable: the backend and its version will be printed when running DeePMD-kit, e.g. TensorFlow v2.15.0."
35+
placeholder: "e.g., TensorFlow v2.15.0"
36+
validations:
37+
required: false
38+
- type: textarea
39+
id: other-version
40+
attributes:
41+
label: Python Version, CUDA Version, GCC Version, LAMMPS Version, etc
42+
description: "If applicable, specify your platform or environment details."
43+
placeholder:
44+
value:
45+
validations:
46+
required: false
47+
- type: textarea
48+
id: details
49+
attributes:
50+
label: Details
51+
description: "If applicable, add more context such as what you are trying to do, what you have tried, and where you got stuck."
52+
placeholder:
53+
value:
54+
validations:
55+
required: false
56+
- type: textarea
57+
id: reproducible-example
58+
attributes:
59+
label: Reproducible Example, Input Files, and Commands
60+
description: |
61+
If applicable, provide a minimal reproducible example.
62+
For software-usage questions, this is often the fastest way to get a useful answer.
63+
placeholder: |
64+
Commands:
65+
```bash
66+
dp train input.json
67+
```
68+
69+
Input / config:
70+
```json
71+
{
72+
"model": {}
73+
}
74+
```
75+
76+
Expected behavior:
77+
...
78+
79+
Actual behavior / error message:
80+
...
81+
value:
82+
validations:
83+
required: false
84+
- type: textarea
85+
id: further
86+
attributes:
87+
label: Further Information, Files, and Links
88+
description: Put any additional information here, including links to docs, papers, related issues, screenshots, or external resources.
89+
placeholder:
90+
value:
91+
validations:
92+
required: false

0 commit comments

Comments
 (0)