Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] Introduce templates to encourage useful issues and pull request #593

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

lgleim
Copy link

@lgleim lgleim commented Jan 17, 2025

Resolves #592

While the CONTRIBUTING guidelines already provide significant guidance on how to structure Bug reports & Feature requests, the large majority of current issue reports does not follow them.

To ensure more structured & time efficient project management, this PR introduces templates to encourage useful issues and pull requests.

This makes it easier for new users to contribute in a structured manner by guiding them in creating useful reports in alignment with the contribution guide, thus

saving reviewers time
improving the quality of issue reports and feature requests
direct questions to the community discussion page
ensure required PR preparation steps were honored

@lgleim
Copy link
Author

lgleim commented Jan 17, 2025

@Kashu7100

@Kashu7100
Copy link
Collaborator

Thank you so much for the initial template!

Could you add CUDA version / nvidia-driver version for the BUG report environment section?
Also - CPU/CPU [e.g. A100, RTX 4090, M3pr, Intel I9-9900k, Ryzen 5900x] is this a typo for GPU?

@Kashu7100 Kashu7100 self-requested a review January 17, 2025 09:51
label: Environment
placeholder: |
- OS: [e.g. Ubuntu 24.04, Windows 11 24H2]
- CPU/CPU [e.g. A100, RTX 4090, M3pr, Intel I9-9900k, Ryzen 5900x]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

e.g. for CPU is wrong.
Also we want:

  • GPU/GPU [e.g. A100, RTX 4090, M3pr, Intel I9-9900k, Ryzen 5900x] (N/A if no GPU)
  • CUDA version (N/A if no GPU)
  • Nvidia-driver version (N/A if no GPU)

- CPU/CPU [e.g. A100, RTX 4090, M3pr, Intel I9-9900k, Ryzen 5900x]
value: |
- OS: [e.g. Ubuntu 24.04, Windows 11 24H2]
- CPU/CPU [e.g. A100, RTX 4090, M3pr, Intel I9-9900k, Ryzen 5900x]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here
e.g. for CPU is wrong.
Also we want:

  • GPU/GPU [e.g. A100, RTX 4090, M3pr, Intel I9-9900k, Ryzen 5900x]
  • CUDA version
  • Nvidia-driver version

1. Go to '...'
2. Load asset '...'
3. Execute function '...'
4. See error
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code snippet or Script is needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature] Introduce templates to encourage useful issues and pull requests
2 participants