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.

Sign up for GitHub

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

Update bug report template #654

Merged
merged 9 commits into from
Apr 24, 2024
Merged

Update bug report template #654

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
87aba3c
Update bug report template
MariamKhalatova Apr 22, 2024
b160de9
feat(.github): update bug report template
MariamKhalatova Apr 22, 2024
92d33ed
feat(doc): add issue opening guidance to contributing
MariamKhalatova Apr 22, 2024
37550ac
fix(.github): typo
MariamKhalatova Apr 23, 2024
a2e4098
Delete .github/ISSUE_TEMPLATE/model-plugin.md
jmcook1186 Apr 23, 2024
aa142ed
fix(doc): updated bug reporting documentation
MariamKhalatova Apr 23, 2024
d52f118
fix(package): refine bug report template
jmcook1186 Apr 24, 2024
1f306c7
fix(package): fix spelling error
jmcook1186 Apr 24, 2024
db01eb3
fix(package): fix header levels and add missing description
jmcook1186 Apr 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/bug-report.md
View file
Open in desktop

This file was deleted.

37 changes: 20 additions & 17 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,30 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: 'bug'
assignees: ''

---
<!--- Please provide us the following info -->

## Descriotion of the Error
MariamKhalatova marked this conversation as resolved.
Show resolved Hide resolved
<!--- Tell us what happened -->

## Expected Behaviour
<!--- Tell us what should happen -->

## Actual Behaviour
<!--- Tell us what happens instead of the expected behavior -->

**Describe the bug**
A clear and concise description of what the bug is.
## Steps to Reproduce
<!--- A set of specific instructions to reproduce the bug. Include code, if relevant -->

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
## And As Additional Info
### EITHER a Stackblitz link
<!--- Replicating the issue -->

**Expected behavior**
A clear and concise description of what you expected to happen.
### OR Manifest File That Generated the Error

**Screenshots**
If applicable, add screenshots to help explain your problem.
### Links to Any Additional Code
<!--- E.g. your plugin code, it must be available online -->

**Additional context**
Add any other context about the problem here.
### Runtime Info
<!--- Such as OS, node version, package.json, IF version -->
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/model-plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Model Plugin
about: Submiting a request to create a model plugin
title: 'Model Plugin - '
labels: model
labels: ''
assignees: ''

---
Expand Down
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,4 +168,23 @@ describe('util/args: ', () => {
})
```

### How to report issues (bugs)

Bug report should contain all the information required to reproduce a bug and to make it as easy as possible to fix. This includes providing the following information

- a description of the error,
- a description of the expected behaviour,
- a description of the actual behaviour,
- steps to reproduce

As an additional info, you can also provide either a Stackblitz link, OR
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
As an additional info, you can also provide either a Stackblitz link, OR
As an additional info, you can also provide either a [Stackblitz](https://stackblitz.com/) link, OR

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
As an additional info, you can also provide either a Stackblitz link, OR
To help us to diagnose and debug your issue, please provide either a Stackblitz link that captures your local environment and failing manifest file, OR:


- the manifest file that generated the error,
- links to any code (e.g. your own plugin code), it must be available online,
- runtime information such as OS, node version, package.json, IF version

Reported bugs should pass the triage stage and be prioritized (low, medium or high).Then the issues will be fixed in the next available opportunity post-triage.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Reported bugs should pass the triage stage and be prioritized (low, medium or high).Then the issues will be fixed in the next available opportunity post-triage.
Reported bugs will be discussed among the team in a weekly bug triage and be assigned a severity (low, medium or high).
High severity bugs will be fixed as soon as possible, whereas medium and low severity bug fixes will likely be backlogged for attention in the next available sprint.
In some cases, we might decide not to fix certain bugs if they are low severity, either because we anticipate fixes coming soon as part of already-scheduled upgrades or because we think the fixes make "good first issues" for community contributors.


Community members are welcome to report any issue they face and also work on fixing the low priority bugs.

*[⬅️ back to the root](/README.md#ief)*
Loading