Skip to content

Issue templates for Edge repo#296

Merged
kevinlind merged 4 commits intoadobe:mainfrom
emdobrin:main-issue-template
Nov 18, 2022
Merged

Issue templates for Edge repo#296
kevinlind merged 4 commits intoadobe:mainfrom
emdobrin:main-issue-template

Conversation

@emdobrin
Copy link
Copy Markdown
Contributor

@emdobrin emdobrin commented Nov 11, 2022

Description

  • Upgraded the issue templates look and feel
  • Added new templates for task and epic issue types
  • All issue templates use the new github issue forms yaml format
    • ℹ️ Note: this feature is currently in beta. More info about creating issue forms here
    • the blank issue template does not seem to load the template correctly when using the yaml format, so that one was not updated

Related Issue

Motivation and Context

This change helps categorizing the issues automatically when the description was filled in through the template, as well as allowing us to indicate the required fields for the different issue types.
In addition, it adds triage-required label to indicate new issue requires our attention and triage prior to picking up the work.
These changes will also work nicely with github project board and issue filters.

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@emdobrin emdobrin changed the title Upgrade the issue templates for bug+feat, add templates for task+epic Issue templates for Edge repo Nov 11, 2022
@codecov
Copy link
Copy Markdown

codecov bot commented Nov 11, 2022

Codecov Report

Merging #296 (7966730) into main (5cb4f03) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #296   +/-   ##
=======================================
  Coverage   95.50%   95.50%           
=======================================
  Files          28       28           
  Lines        1045     1045           
=======================================
  Hits          998      998           
  Misses         47       47           

body:
- type: checkboxes
attributes:
label: Before logging a bug report please confirm the following
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Reword to something like following:

label: Disclosures and preliminary checks
description: Please check the following items before logging a bug

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the suggestion. Updated to :

label:  Prerequisites
description: Please check the following items before logging a new bug report.

@emdobrin emdobrin requested review from addb and kevinlind November 16, 2022 17:34
@kevinlind kevinlind merged commit add7dcb into adobe:main Nov 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants