-
Notifications
You must be signed in to change notification settings - Fork 441
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
Add issue forms #2601
Add issue forms #2601
Conversation
Codecov Report
@@ Coverage Diff @@
## main #2601 +/- ##
=======================================
Coverage 93.69% 93.69%
=======================================
Files 75 75
Lines 16156 16156
=======================================
Hits 15138 15138
Misses 1018 1018 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a great idea. The problem with plain text is that the issues created can be out of the format. I think this will contribute to better management of issues.
Co-authored-by: Tetsuo Koyama <tkoyama010@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Overview
GitHub recently added the option to create 'forms' for Issues. I've converted PyVista's
bug-report.md
,feature-request.md
, andmaintenance-request.md
files into*.yml
files to make issue creation a bit more user-friendly.Here is a link to the issues form formatting guidelines.
Details
*.yml
files provide multiple text boxes to guide the user during the issue creation. For example, the left image below is the previous view of thebug-report.md
, and the right image below is the proposedbug-report.yml
form.required: true/false
flag that won't let users open an issue unless the required information has been added (e.g., thepv.Report()
). Input requirements for each box can be set under thevalidations:
element, with therequired:
key.