[Documentation] switch-to-issue-forms #16
Labels
Flag: Good First Issue
An issue that is suitable for new contributors
Priority: Medium
Should be resolved in the near future and only trumps low-priority issues
Scope: Small
Issue that can probably be dealt with within a single day of concentrated work by the team
Status: Resolved
An issue that was in review and got merged into one of the main branches
Type: Documentation
Improvements to the documentation suite, as well as documentation pages and code comments
Milestone
Object of Interest
The issue templates
Problem/Motivation
Issue forms enable a better presentation as well as better validation possibilities. They can also enforce using a template when creating a new issue. Also, the issue form configuration file is the single point of truth that contains all information concerning the issue form, like default labels, assignees, etc.
Solution Proposal
Convert every issue template to a GitHub issue form configuration file. Keep the old issue templates to allow for an individual choice between these two options.
The security issue template is excluded because it will be dropped in favor of GitHub's security advisories as mentioned in issue #20.
Impact
When updating a template, it will be necessary to change two files instead of one to keep the contents of the classic issue template and the new issue form synchronous.
Acceptance Criteria
Further Information
Related Issues
The text was updated successfully, but these errors were encountered: