docs(discussions): add lightweight q-and-a discussion template#5385
Open
njzjz-bot wants to merge 7 commits intodeepmodeling:masterfrom
Open
docs(discussions): add lightweight q-and-a discussion template#5385njzjz-bot wants to merge 7 commits intodeepmodeling:masterfrom
njzjz-bot wants to merge 7 commits intodeepmodeling:masterfrom
Conversation
for more information, see https://pre-commit.ci
Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
…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)
Problem - The current discussion templates are broader than needed for this branch - The Q&A form asks for overlapping information and treats software-specific details as too central Change - keep only the Q&A discussion template - make most fields optional and clarify that users should fill them only when relevant - align field labels with the existing issue templates where practical - merge the latest upstream master into the branch Authored by OpenClaw (model: gpt-5.4)
for more information, see https://pre-commit.ci
Contributor
📝 WalkthroughWalkthroughAdded GitHub Discussions template configuration with a Q&A form template and documentation. The template includes fields for questions, environment details, version information, and reproducible examples. The README documents the template structure and GitHub Discussion form key limitations. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (3)
.github/DISCUSSION_TEMPLATE/q-a.yml (3)
47-83: Excellent placeholder example for reproducible cases.The structured placeholder for the reproducible example (lines 63-80) is particularly helpful, showing users exactly how to format commands, config, expected behavior, and actual results. This will significantly improve the quality of Q&A submissions.
Similar to the earlier fields, consider removing empty
placeholder:,value:keys at lines 52, 53, and 81 for consistency.♻️ Optional cleanup
- type: textarea id: details attributes: label: Details description: "If applicable, add more context such as what you are trying to do, what you have tried, and where you got stuck." - placeholder: - value: validations: required: falseActual behavior / error message: ... - value: validations: required: false🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/DISCUSSION_TEMPLATE/q-a.yml around lines 47 - 83, Remove the redundant empty keys by deleting the empty "placeholder:" and "value:" entries for the textarea with id "details" and the textarea with id "reproducible-example"; locate the blocks defining id: details and id: reproducible-example and remove their empty placeholder and value lines so the YAML is consistent and has no superfluous empty keys.
84-92: Good comprehensive final field for additional context.The "Further Information, Files, and Links" field provides a good catch-all for supplementary information. Consider removing the empty
placeholder:andvalue:keys at lines 89-90 for consistency with the earlier cleanup suggestions.♻️ Optional cleanup
- type: textarea id: further attributes: label: Further Information, Files, and Links description: Put any additional information here, including links to docs, papers, related issues, screenshots, or external resources. - placeholder: - value: validations: required: false🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/DISCUSSION_TEMPLATE/q-a.yml around lines 84 - 92, Remove the unnecessary empty YAML keys under the "further" textarea field: delete the empty placeholder: and value: entries so the attributes block only contains label and description; locate the textarea with id: further and attributes.label "Further Information, Files, and Links" and remove those two keys to match the earlier cleanup style.
13-46: Consider removing empty YAML keys for cleaner code.The form structure is correct and the field descriptions are helpful. However, empty
value:andplaceholder:keys (lines 19, 43, 44) add no value and can be omitted entirely in YAML.♻️ Proposed cleanup
- type: textarea id: question attributes: label: Question description: Please describe your question clearly. placeholder: What would you like to ask? - value: validations: required: true- type: textarea id: other-version attributes: label: Python Version, CUDA Version, GCC Version, LAMMPS Version, etc description: "If applicable, specify your platform or environment details." - placeholder: - value: validations: required: false🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/DISCUSSION_TEMPLATE/q-a.yml around lines 13 - 46, Remove the redundant empty YAML keys by deleting the empty "value:" and "placeholder:" entries found under the form items (e.g., the "question" textarea and the "other-version" textarea where empty value/placeholder keys appear); keep all other attributes (id, label, description, validations) intact so the form semantics remain unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In @.github/DISCUSSION_TEMPLATE/q-a.yml:
- Around line 47-83: Remove the redundant empty keys by deleting the empty
"placeholder:" and "value:" entries for the textarea with id "details" and the
textarea with id "reproducible-example"; locate the blocks defining id: details
and id: reproducible-example and remove their empty placeholder and value lines
so the YAML is consistent and has no superfluous empty keys.
- Around line 84-92: Remove the unnecessary empty YAML keys under the "further"
textarea field: delete the empty placeholder: and value: entries so the
attributes block only contains label and description; locate the textarea with
id: further and attributes.label "Further Information, Files, and Links" and
remove those two keys to match the earlier cleanup style.
- Around line 13-46: Remove the redundant empty YAML keys by deleting the empty
"value:" and "placeholder:" entries found under the form items (e.g., the
"question" textarea and the "other-version" textarea where empty
value/placeholder keys appear); keep all other attributes (id, label,
description, validations) intact so the form semantics remain unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 657441a9-d821-4212-af53-61fb1fc44517
📒 Files selected for processing (2)
.github/DISCUSSION_TEMPLATE/README.md.github/DISCUSSION_TEMPLATE/q-a.yml
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #5385 +/- ##
==========================================
- Coverage 80.39% 80.39% -0.01%
==========================================
Files 812 812
Lines 83476 83476
Branches 4051 4050 -1
==========================================
- Hits 67113 67112 -1
Misses 15139 15139
- Partials 1224 1225 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Change
.github/DISCUSSION_TEMPLATE/q-a.yml.github/DISCUSSION_TEMPLATE/README.mdNotes
q-a.yml), and the top-level schema uses supported keys only.Authored by OpenClaw (model: gpt-5.4)
Summary by CodeRabbit