Improve issue templates (#1686)

This commit is contained in:
Charles Bochet
2023-09-20 20:17:09 -07:00
committed by GitHub
parent 2d758c990b
commit 6dbe388ab9
3 changed files with 113 additions and 8 deletions

View File

@ -1,19 +1,55 @@
---
name: Add new feature / behavior
about: Describe the desired product increment
title: ''
title: 'Ex: Add custom field from Companies / People table options menu'
labels: ''
assignees: ''
---
**Current behavior**
A clear and concise description of what the current behavior is.
Please also add screenshots
## Scope & Context
**Expected behavior**
**Example:**
```
We are working on enabling users to add custom fields in their workspace.
The ticket is about adding the custom field feature on Companies and People pages only.
```
## Current behavior
A clear and concise description of what the current behavior is.
Please also add **screenshots** of the existing application.
**Example:**
```
On Companies and People pages, the "field" menu item from the option menu shows both displayed columns, and hidden columns
[screenshot]
```
## Expected behavior
A clear and concise description of what you want to happen.
Please also add screenshots or link to figma if available
Please also add **figma screenshots or figma links** if available
**Additional context**
Add any other context or screenshots about the feature request here.
**Example:**
```
The "field" menu item from the option menu should only display visible columns. To display a new column, the user should click on "Add field" at the bottom of the menu.
[figma screenshot 1]
[figma link 1]
Clicking on this button should swap the menu with the same menu that is used by pressing the "+" button on the table title bar, showing "Add custom field option"
[figma screenshot 2]
[figma link 2]
Clicking on "Add custom field" should open swap the menu with the "field type" menu
...
```
## Technical inputs
**Example:**
```
- Modify TableOptionsDropdownContent to add the new "Add field Item" using a MenuItem component
- Create an internal state 'isAddingField' to track the progress in the flow. Set this state to true on "Add field Item" onClick
- ...
```

36
.github/ISSUE_TEMPLATE/report-bug.md vendored Normal file
View File

@ -0,0 +1,36 @@
---
name: Report a bug
about: Report a bug or a functional regression
title: 'Ex: In DarkMode, a blank square appears in bottom right corner while scrolling'
labels: ['type: bug']
assignees: ''
---
## Bug Description
A clear and concise description of what the current behavior is.
Please also add **screenshots** of the existing application.
**Example:**
```
In DarkMode, when scrollbar are displayed (for example on Companies page, with enough companies in the list), we see a blank square in the bottom right corner
[screenshot]
```
## Expected behavior
A clear and concise description of what the expected behavior is.
**Example:**
```
The blank square should be transparent (invisible)
```
## Technical inputs
**Example:**
```
- We are displaying custom scrollbars that disappear when the user is not scrolling. See ScrollWrapper.
- Probably fixable with CSS
```

View File

@ -0,0 +1,33 @@
---
name: Request technical chore
about: Request technical work that does not provide any product increment (aka refactoring)
title: ''
labels: ['type: chore']
assignees: ''
---
## Scope & Context
**Example:**
```
In previous PRs: #1667 and #1636, we have introduced a new MenuItem draggable in the dropdown and implemented a drag and drop behavior.
This is working but it would be great to refactor this into separated components so we can re-use them.
```
## Technical inputs
A clear and detailed description of what the expected change is.
Describe components, files and folders that should be touch and how.
Using a Task list can be helpful
**Example:**
```
Having a list that is draggable will be useful, not only in dropdown.
Create a folder @/ui/draggable-list with a DraggableList component
This component should take as prop: itemsComponents, onDragEnd((previousIndex, nextIndex) => {})
Use this component in ViewFieldsVisibilityDropdownSection (move the logic from ViewFieldsVisibilityDropdownSection to DraggableList) by passing a list of DraggableMenuItems
Add a storybook test on this list (we don't know how to actually test the draggable behavior, but we can at least make sure the component renders correctly a list of items)
```