Switch to form-based GitHub issue templates #916
Merged
Conversation
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
This project provides the contributors with templates for the fundamental categories of issues: - bug report - feature request This is helpful to the maintainers and developers because it establishes a standardized framework for the issues and encourages the contributors to provide the essential information. GitHub's original issue template system is very crude, simply pre-populating the issue description field with the text from the template file. https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-templates The contributor may be confused by being presented with a mass of Markdown and placeholder content where they expected a field to write their issue. They also may find it inconvenient to manuever around the framework content and replace the placeholder content. A far better system is now available with GitHub's recently introduced form-based issue templates: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms The user is now presented with a web form. These may include multi-line input fields that have the same formatting and attachment capabilities as the standard GitHub Issue composer, but also additional elements such as menus and checkboxes. The use of this form-based system should provide a much better experience for the contributors and also result in higher quality issues.
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.
Motivation
As a very popular tool with a strong community, the issue tracker of this project is very active and likely to become even more so over time. For this reason, it is worthwhile to make the issue creation and management process as efficient as possible for the contributors, maintainers, and developers.
GitHub has recently introduced a nice feature for enhancing the issue creation process, the use of which is proposed here.
Change description
This project provides the contributors with templates for the fundamental categories of issues:
These templates are helpful to the maintainers and developers because it establishes a standardized framework for the issues and encourages the contributors to provide the essential information.
GitHub's original issue template system is very crude, simply pre-populating the issue description field with the text from the template file.
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-templates
The contributor may be confused by being presented with a mass of Markdown and placeholder content where they expected a field to write their issue. They also may find it inconvenient to manuever around the framework content and replace the placeholder content.
A far better system is now available with GitHub's recently introduced form-based issue templates:
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms
The user is now presented with a web form. These may include multi-line input fields that have the same formatting and attachment capabilities as the standard GitHub Issue composer, but also additional elements such as menus and checkboxes.
The use of this form-based system should provide a much better experience for the contributors and also result in higher quality issues.
Issue report creation before:
Issue report creation after:
Reviewer checklist