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

[Documentation] switch-to-issue-forms #16

Closed
14 tasks done
L483 opened this issue Jan 23, 2023 · 0 comments · Fixed by #19
Closed
14 tasks done

[Documentation] switch-to-issue-forms #16

L483 opened this issue Jan 23, 2023 · 0 comments · Fixed by #19
Assignees
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

Comments

@L483
Copy link
Owner

L483 commented Jan 23, 2023

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

  • create bug report form
  • create design form
  • create documentation form
  • create feature change form
  • create feature drop form
  • create feature request form
  • create maintenance form
  • create performance form
  • create pipeline form
  • create question form
  • create refactor form
  • create testing form
  • create text correction form
  • create tooling form

Further Information

Related Issues

@L483 L483 added Type: Documentation Improvements to the documentation suite, as well as documentation pages and code comments Status: Pending An issue that was neither accepted nor rejected yet labels Jan 23, 2023
@L483 L483 added this to the Issue Templates milestone Jan 23, 2023
@L483 L483 self-assigned this Jan 23, 2023
@L483 L483 added 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 Flag: Good First Issue An issue that is suitable for new contributors labels Jan 23, 2023
@L483 L483 added Status: Resolved An issue that was in review and got merged into one of the main branches and removed Status: Pending An issue that was neither accepted nor rejected yet labels Feb 1, 2023
@L483 L483 linked a pull request Feb 1, 2023 that will close this issue
@L483 L483 closed this as completed in #19 Feb 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant