Skip to content

Commit

Permalink
Issue template tweaks (#1911)
Browse files Browse the repository at this point in the history
# Pull Request

## 🤨 Rationale

- Removed the user story issue template since it did not align with any
categories on the design system board
- Aligned file names to repo conventions
- Tweaked the comment pattern to make lists easier to uncomment
- Remove the (PO Only) / (Dev only) description comments. Seemed noisy
and we can re-add them if it becomes an issue.

## 👩‍💻 Implementation

- See above

## 🧪 Testing

Will test out the templates after merge.

## ✅ Checklist

- [x] I have updated the project documentation to reflect my changes or
determined no changes are needed.
  • Loading branch information
rajsite authored Mar 7, 2024
1 parent ca506be commit 7af218a
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 30 deletions.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@ Search open/closed issues before submitting. Someone may have requested the same

<!--- Provide a clear and concise description of the feature you're proposing. -->

<!--- The implementing team may build a list of tasks/sub-issues here:
<!--- The implementing team may build a list of tasks/sub-issues here: -->

## 📋 Tasks
- [ ] This is a subtask of the feature. (It can be converted to an issue.)

<!--
- [ ] This is a subtask of the feature.
-->
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: 👈 Interaction Design Request
about: (PO ONLY) A small chunk of work to be done by an Interaction Designer
about: A small chunk of work to be done by an Interaction Designer
title: 'nimble-{name} interaction design request'
labels: 'interaction design,triage'
---
Expand All @@ -16,20 +16,19 @@ labels: 'interaction design,triage'

## 🎯 Core Requirements

<!-- Outline the essential requirements of the component. What does the user need to be able to do with the component? E.g. For a date picker
<!-- Outline the essential requirements of the component. What does the user need to be able to do with the component? E.g. For a date picker:
<!--
- User must to be able to specify a _specific date_ for use in filter query
- User should not be able to specify an invalid date
- User must be able to enter date with keyboard interaction alone
--->
-->

## 🍆 Non-requirements

<!-- What ideas are out of scope for this component? E.g. For a date picker
<!-- What ideas are out of scope for this component? E.g. For a date picker: -->
<!--
- User does not need to pick the date from a calendar widget
- … -->

-->

## 🥅 Acceptance Criteria

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
name: 💡 New Component
about: (DEV TEAM ONLY) New Nimble component
about: New Nimble component
title: 'nimble-{name} Component'
labels: 'new component,enhancement'
labels: 'new component,enhancement,triage'
---

# 💡 New Component
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: 🧹 Tech Debt
about: (DEV TEAM ONLY) Non-user-visible improvement to code or development process
about: Non-user-visible improvement to code or development process
title: ''
labels: 'tech debt,triage'
---
Expand Down
9 changes: 0 additions & 9 deletions .github/ISSUE_TEMPLATE/user_story.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: 🎨 Visual Design Request
about: (DEV TEAM ONLY) A small chunk of work to be done by Visual Designer
about: A small chunk of work to be done by Visual Designer
title: 'nimble-{name} visual design request'
labels: 'visual design,triage'
---
Expand All @@ -16,20 +16,19 @@ labels: 'visual design,triage'

## 🎯 Core Requirements

<!-- Outline the essential requirements of the component visual design. What states, variations, or other constraints are required? E.g. For a date picker
<!-- Outline the essential requirements of the component visual design. What states, variations, or other constraints are required? E.g. For a date picker: -->
<!--
- Component needs block and outline appearances
- Component needs to fit in an editable table cell and in a details panel
- Reuse the existing calendar icon
--->
-->

## 🍆 Non-requirements

<!-- What ideas are out of scope for this component? E.g. For a date picker
<!-- What ideas are out of scope for this component? E.g. For a date picker: -->
<!--
- Component does not need a ghost appearance
- … -->

-->

## 🥅 Acceptance Criteria

Expand Down

0 comments on commit 7af218a

Please sign in to comment.