Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Aug 21, 2025

This PR adds comprehensive GitHub Discussion templates to address the lack of reproducible examples in community discussions. The templates guide users to provide detailed information that makes it easier for the community to offer effective help.

What's Added

The new .github/DISCUSSION_TEMPLATE/ directory contains five specialized templates:

  1. General Question - For straightforward questions about DeePMD-kit usage and concepts
  2. Usage Help - For detailed troubleshooting with strong emphasis on reproducible examples
  3. Ideas and Suggestions - For proposing new features and improvements
  4. Show and Tell - For sharing projects and achievements using DeePMD-kit
  5. Potential Bug Discussion - For discussing possible bugs before creating formal issues

Key Features

Each template is designed to encourage comprehensive information sharing:

  • Reproducible Examples: Templates include detailed sections for input files, configurations, commands, and error messages
  • Version Information: Structured fields for DeePMD-kit version, backend details, and installation method
  • Clear Structure: Consistent with existing issue templates using GitHub's YAML form syntax
  • Appropriate Labels: Each template applies relevant labels for proper categorization

The templates particularly address the core issue by including sections like:

- type: textarea
  id: reproducible-example
  attributes:
    label: Reproducible Example
    description: |
      **This section is crucial for getting effective help!**
      
      Please provide a complete, minimal example that others can use to reproduce your issue...

Example Impact

Before: "My training isn't working, what's wrong?"

After: Users are guided to provide:

  • Complete input.json configuration
  • Dataset structure and sample files
  • Exact commands run
  • Full error messages
  • System environment details

This structured approach will significantly improve the quality of discussions and make it easier for community members to provide targeted assistance.

Fixes #4506.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@Copilot Copilot AI assigned Copilot and njzjz Aug 21, 2025
Copy link
Contributor Author

Copilot AI commented Aug 21, 2025

@njzjz 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs.

I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review.

@github-actions github-actions bot added the Docs label Aug 21, 2025
@Copilot Copilot AI changed the title [WIP] [Feature Request] Add discussion template Add GitHub Discussion templates with emphasis on reproducible examples Aug 21, 2025
@Copilot Copilot AI requested a review from njzjz August 21, 2025 10:13
Copilot finished work on behalf of njzjz August 21, 2025 10:13
@njzjz njzjz changed the base branch from master to devel August 21, 2025 10:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request] Add discussion template
2 participants