Skip to content

Commit 79f150c

Browse files
committed
fix(discussions): repair discussion form schema\n\nProblem\n- GitHub Discussions rejected the templates on this branch because the form files used invalid top-level keys such as and \n- Several template filenames also did not match the actual discussion category slugs\n\nChange\n- replace invalid top-level keys with supported discussion form keys\n- rename templates to match category slugs and drop the unmatched extra template\n- update the template README to document the valid mapping\n\nAuthored by OpenClaw (model: gpt-5.4)
1 parent 7f9af3c commit 79f150c

6 files changed

Lines changed: 13 additions & 194 deletions

File tree

Lines changed: 9 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,15 @@
11
# Discussion Templates
22

3-
This directory contains GitHub Discussion templates for the DeePMD-kit repository. These templates help guide users to provide comprehensive information when starting discussions, particularly emphasizing the importance of reproducible examples.
3+
This directory contains GitHub Discussion category forms for DeePMD-kit.
44

5-
## Available Templates
5+
## Active templates
66

7-
### 1. General Question (`general-question.yml`)
8-
For general questions about DeePMD-kit usage, features, or concepts. Use this when you have a straightforward question that doesn't require extensive troubleshooting.
7+
- `general.yml`**General**
8+
- `q-a.yml`**Q&A**
9+
- `ideas.yml`**Ideas**
10+
- `show-and-tell.yml`**Show and tell**
911

10-
### 2. Usage Help (`usage-help.yml`)
11-
For detailed help with specific DeePMD-kit usage scenarios. **This template strongly emphasizes providing reproducible examples** to help community members provide effective assistance.
12+
## Notes
1213

13-
### 3. Ideas and Suggestions (`ideas-suggestions.yml`)
14-
For proposing new features, improvements, or enhancements to DeePMD-kit. Includes sections for use cases, related work, and implementation thoughts.
15-
16-
### 4. Show and Tell (`show-and-tell.yml`)
17-
For sharing projects, research, or achievements using DeePMD-kit. Encourages sharing reproducible information and lessons learned.
18-
19-
### 5. Potential Bug Discussion (`potential-bug.yml`)
20-
For discussing behavior that might be a bug before creating a formal issue. **Emphasizes providing complete reproducible examples** to help confirm whether the behavior is indeed a bug.
21-
22-
## Key Features
23-
24-
All templates are designed to:
25-
- **Encourage reproducible examples**: Each template emphasizes the importance of providing complete, minimal examples that others can reproduce
26-
- Follow the repository's existing style and conventions
27-
- Include appropriate labels for categorization
28-
- Provide clear guidance on what information to include
29-
- Help users structure their discussions effectively
30-
31-
## Usage
32-
33-
When users start a new discussion, they will be presented with these template options. The templates guide them to provide:
34-
35-
- Clear problem descriptions
36-
- Version information
37-
- Reproducible examples with:
38-
- Input files
39-
- Configuration files
40-
- Commands run
41-
- Expected vs actual behavior
42-
- Complete error messages
43-
44-
This addresses the issue mentioned in #4506 where "many discussions do not give reproduced examples."
14+
GitHub Discussion form filenames must match the target discussion category slug exactly.
15+
Top-level keys allowed by GitHub are limited; use `title`, `labels`, and `body`.

.github/DISCUSSION_TEMPLATE/usage-help.yml renamed to .github/DISCUSSION_TEMPLATE/general.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
name: Usage Help
2-
description: Get help with using DeePMD-kit - provide reproducible examples for the best assistance
1+
title: "[General] "
32
labels: ["help wanted", "usage"]
43
body:
54
- type: textarea

.github/DISCUSSION_TEMPLATE/ideas-suggestions.yml renamed to .github/DISCUSSION_TEMPLATE/ideas.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
name: Ideas and Suggestions
2-
description: Share ideas for new features, improvements, or enhancements to DeePMD-kit
1+
title: "[Ideas] "
32
labels: ["idea", "enhancement"]
43
body:
54
- type: textarea

.github/DISCUSSION_TEMPLATE/potential-bug.yml

Lines changed: 0 additions & 148 deletions
This file was deleted.

.github/DISCUSSION_TEMPLATE/general-question.yml renamed to .github/DISCUSSION_TEMPLATE/q-a.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
name: General Question
2-
description: Ask a general question about DeePMD-kit usage, features, or concepts
1+
title: "[Q&A] "
32
labels: ["question"]
43
body:
54
- type: textarea

.github/DISCUSSION_TEMPLATE/show-and-tell.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
name: Show and Tell
2-
description: Share your projects, research, or achievements using DeePMD-kit
1+
title: "[Show and tell] "
32
labels: ["show and tell"]
43
body:
54
- type: textarea

0 commit comments

Comments
 (0)