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

Add issue forms #2601

Merged
merged 31 commits into from
May 15, 2022
Merged

Add issue forms #2601

merged 31 commits into from
May 15, 2022

Conversation

JacobBumgarner
Copy link
Contributor

@JacobBumgarner JacobBumgarner commented May 14, 2022

Overview

GitHub recently added the option to create 'forms' for Issues. I've converted PyVista's bug-report.md, feature-request.md, and maintenance-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

  • The previous issue templates provide a single text box for user input. This single-field input can be a bit messy for long issues. The updated form *.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 the bug-report.md, and the right image below is the proposed bug-report.yml form.

Screen Shot 2022-05-14 at 4 03 49 PM Screen Shot 2022-05-14 at 4 03 06 PM


  • The issues form template also adds a required: true/false flag that won't let users open an issue unless the required information has been added (e.g., the pv.Report()). Input requirements for each box can be set under the validations: element, with the required: key.
  • For example, users are forced to describe the desired feature and agree to the community code of conduct before they can open a feature request issue. Image below.

Screen Shot 2022-05-14 at 4 07 07 PM

@github-actions github-actions bot added the maintenance Low-impact maintenance activity label May 14, 2022
@JacobBumgarner JacobBumgarner changed the title Maint/add issue forms Add issue forms May 14, 2022
@codecov
Copy link

codecov bot commented May 14, 2022

Codecov Report

Merging #2601 (969d8c7) into main (6c93e83) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #2601   +/-   ##
=======================================
  Coverage   93.69%   93.69%           
=======================================
  Files          75       75           
  Lines       16156    16156           
=======================================
  Hits        15138    15138           
  Misses       1018     1018           

Copy link
Member

@tkoyama010 tkoyama010 left a 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.

.gitignore Outdated Show resolved Hide resolved
Co-authored-by: Tetsuo Koyama <tkoyama010@gmail.com>
Copy link
Member

@tkoyama010 tkoyama010 left a comment

Choose a reason for hiding this comment

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

LGTM

@akaszynski akaszynski merged commit cdc9117 into pyvista:main May 15, 2022
@JacobBumgarner JacobBumgarner deleted the maint/add_issue_forms branch June 28, 2022 16:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Low-impact maintenance activity
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants