From 87aba3c26ab0d4880f3d8d82dbe9e94edb1490c9 Mon Sep 17 00:00:00 2001 From: MariamKhalatova <109615222+MariamKhalatova@users.noreply.github.com> Date: Mon, 22 Apr 2024 23:00:27 +0400 Subject: [PATCH 1/9] Update bug report template --- .github/ISSUE_TEMPLATE/bug_report.md | 42 +++++++++++++++++--------- .github/ISSUE_TEMPLATE/model-plugin.md | 2 +- 2 files changed, 28 insertions(+), 16 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 816593c4e..4217b2b34 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -2,26 +2,38 @@ name: Bug report about: Create a report to help us improve title: '' -labels: 'bug' +labels: bug assignees: '' --- -**Describe the bug** -A clear and concise description of what the bug is. +--- +name: Bug report +about: Create a report to help us improve +labels: 'bug' +--- + + +## Descriotion of the Error + + +## Expected Behaviour + + +## Actual Behaviour + + +## Steps to Reproduce + -**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 + -**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 + -**Additional context** -Add any other context about the problem here. +### Runtime Info + diff --git a/.github/ISSUE_TEMPLATE/model-plugin.md b/.github/ISSUE_TEMPLATE/model-plugin.md index 7b7a0122a..dbfc99b04 100644 --- a/.github/ISSUE_TEMPLATE/model-plugin.md +++ b/.github/ISSUE_TEMPLATE/model-plugin.md @@ -2,7 +2,7 @@ name: Model Plugin about: Submiting a request to create a model plugin title: 'Model Plugin - ' -labels: model +labels: '' assignees: '' --- From b160de971c06c9a1e0a29bf21f16ec816a2df2e5 Mon Sep 17 00:00:00 2001 From: MariamKhalatova Date: Mon, 22 Apr 2024 23:09:15 +0400 Subject: [PATCH 2/9] feat(.github): update bug report template --- .github/ISSUE_TEMPLATE/bug-report.md | 32 ---------------------------- .github/ISSUE_TEMPLATE/bug_report.md | 9 -------- 2 files changed, 41 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index ba513c174..000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,32 +0,0 @@ -Issue tracker is **ONLY** used for reporting bugs. - - - -## Expected Behavior - - -## Actual Behavior - - -## Ideas for Solution - - -## Steps to Reproduce - - -1. -2. -3. -4. - -## Context (Environment) - - - - - -## Detailed Description - - -## Possible Implementation - diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 4217b2b34..ab5fad38e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,12 +1,3 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: bug -assignees: '' - ---- - --- name: Bug report about: Create a report to help us improve From 92d33ed188bfa9862b64c34250d9a4e65875d1af Mon Sep 17 00:00:00 2001 From: MariamKhalatova Date: Mon, 22 Apr 2024 23:10:15 +0400 Subject: [PATCH 3/9] feat(doc): add issue opening guidance to contributing --- CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 13b12ed80..19eee9450 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 + +- 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. + +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)* From 37550ac439410d8e235497a87d208e739376088e Mon Sep 17 00:00:00 2001 From: MariamKhalatova Date: Tue, 23 Apr 2024 09:59:31 +0400 Subject: [PATCH 4/9] fix(.github): typo --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index ab5fad38e..c376353dc 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -5,7 +5,7 @@ labels: 'bug' --- -## Descriotion of the Error +## Description of the Error ## Expected Behaviour From a2e4098f40bd58fdd37576026eeef280cc710171 Mon Sep 17 00:00:00 2001 From: Joseph Cook <33655003+jmcook1186@users.noreply.github.com> Date: Tue, 23 Apr 2024 09:33:16 +0100 Subject: [PATCH 5/9] Delete .github/ISSUE_TEMPLATE/model-plugin.md Signed-off-by: Joseph Cook <33655003+jmcook1186@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/model-plugin.md | 64 -------------------------- 1 file changed, 64 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/model-plugin.md diff --git a/.github/ISSUE_TEMPLATE/model-plugin.md b/.github/ISSUE_TEMPLATE/model-plugin.md deleted file mode 100644 index dbfc99b04..000000000 --- a/.github/ISSUE_TEMPLATE/model-plugin.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -name: Model Plugin -about: Submiting a request to create a model plugin -title: 'Model Plugin - ' -labels: '' -assignees: '' - ---- - -- **What**: -- **Why**: -- **DoD**: -- [ ] Does the model meet the specification? -- [ ] Does the model have complete test coverage, including edge cases, happy path and error cases? -- [ ] Is the code documented? - -## Config -- `variable`: If this variable is present in the top level config what behaviour does it trigger? What is the default value if none is provided? - -## Inputs -_List the variables this model expects in an input input_ -- `variable`: Description - -## Outputs -_List the variables this model exports out as an impact_ -- `variable`: Description - -## Behavior -What does the model do to turn the inputs into outputs? List any important equations or references. - -## Assumptions -What are the core assumptions this model makes? - -## Limitations -In what situations is this model limited in it's function, behaviour, accuracy etc... - -## Example -Provide at least one example of some input config and inputs. This is in pimpl format not rimpl format, so the config is the global config and all parameters must be present on the input. - -### Input - -```yaml -config: - key: value -inputs: - - timestamp: 2023-07-06T00:00 - duration: 3600 -``` - -### Output - -```yaml -config: - key: value -inputs: - - timestamp: 2023-07-06T00:00 - duration: 3600 - yyyy: zzzz -outputs: - - timestamp: 2023-07-06T00:00 - duration: 3600 - yyyy: zzzz - aaaa: bbbb -``` From aa142eda68a5f579bf92aa1e40c8b645765281d1 Mon Sep 17 00:00:00 2001 From: MariamKhalatova Date: Tue, 23 Apr 2024 19:52:44 +0400 Subject: [PATCH 6/9] fix(doc): updated bug reporting documentation --- CONTRIBUTING.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 19eee9450..20b2d121b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -177,14 +177,17 @@ Bug report should contain all the information required to reproduce a bug and to - a description of the actual behaviour, - steps to reproduce -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](https://stackblitz.com/) 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. +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)* From d52f1186d055dfd940cafb8306e3af7092d7c99c Mon Sep 17 00:00:00 2001 From: jmc <33655003+jmcook1186@users.noreply.github.com> Date: Wed, 24 Apr 2024 13:19:00 +0100 Subject: [PATCH 7/9] fix(package): refine bug report template --- .github/ISSUE_TEMPLATE/bug_report.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c376353dc..fbb5bc8ed 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -17,11 +17,14 @@ labels: 'bug' ## Steps to Reproduce -## And As Additional Info -### EITHER a Stackblitz link - -### OR Manifest File That Generated the Error +### Link to online environment + + + + +### Manifest File That Generated the Error ### Links to Any Additional Code From 1f306c7909e9ed42a49b8b0f04573db43a67ac34 Mon Sep 17 00:00:00 2001 From: jmc <33655003+jmcook1186@users.noreply.github.com> Date: Wed, 24 Apr 2024 13:20:13 +0100 Subject: [PATCH 8/9] fix(package): fix spelling error --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index fbb5bc8ed..3bbbc3640 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -19,7 +19,7 @@ labels: 'bug' ### Link to online environment - + From db01eb3acce7c1ee5b7d4629b43b7f77fcc40a64 Mon Sep 17 00:00:00 2001 From: jmc <33655003+jmcook1186@users.noreply.github.com> Date: Wed, 24 Apr 2024 13:22:42 +0100 Subject: [PATCH 9/9] fix(package): fix header levels and add missing description --- .github/ISSUE_TEMPLATE/bug_report.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 3bbbc3640..002c22041 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -18,16 +18,18 @@ labels: 'bug' -### Link to online environment +## Link to online environment -### Manifest File That Generated the Error +## Manifest File That Generated the Error -### Links to Any Additional Code + + +## Links to Any Additional Code -### Runtime Info +## Runtime Info