From 3b67ef834ff698bedf6ed4aa09955e99a0b63624 Mon Sep 17 00:00:00 2001 From: Bratn Date: Mon, 25 May 2020 14:31:25 +0200 Subject: [PATCH 1/3] issue report template draft --- docs/issue-report-template.md | 38 +++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 docs/issue-report-template.md diff --git a/docs/issue-report-template.md b/docs/issue-report-template.md new file mode 100644 index 0000000..dab9496 --- /dev/null +++ b/docs/issue-report-template.md @@ -0,0 +1,38 @@ +# Issue Report Template +Use this template to create a technical bug report for ACE Knowledge Widgets regarding use of APIs or in custom self-hosting setups. + +## Issue Description +_Provide a general issue description._ + +## Expected Behavior +_What is the expected behaviour? Provide link to relevant documentation describing the expected behaviour, if available._ + +## Actual Behavior +_What is the actual behaviour?_ + +## Steps to Reproduce +_Specify how this bug can be reproduced, step by step._ + +## Environment + +### Link to Widget +_URL to a page where the widget is implemented and where the particular error can be reproduced._ + +### Link to Repository (optional) +_URL to a Git repository where the particular error can be repdocued._ + +### Distribution Method +_Describe the distribution method and setup used._ + +- [ ] ACE Knowledge Cloud +- [ ] ACE Web SDK Cloud +- [ ] ACE Knowledge self-hosting +- [ ] ACE Web SDK self-hosting + +### Package(s) and Versions +_If it's a self-hosting setup, specify all packages and versions used in the distribution, e.g.:_ +```text +@humany/widget-core@1.0.23 +@humany/widget-types-grid@1.0.23 +... +``` From 01e59f2175adb2bb6e0396513efb38e6d37eae9e Mon Sep 17 00:00:00 2001 From: Bratn Date: Mon, 25 May 2020 14:51:17 +0200 Subject: [PATCH 2/3] docs: add more items to bug report template --- docs/issue-report-template.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/issue-report-template.md b/docs/issue-report-template.md index dab9496..092c4ab 100644 --- a/docs/issue-report-template.md +++ b/docs/issue-report-template.md @@ -13,6 +13,9 @@ _What is the actual behaviour?_ ## Steps to Reproduce _Specify how this bug can be reproduced, step by step._ +## Has this been working before? +_If yes, please specify when the bug was introduced (version or date)._ + ## Environment ### Link to Widget @@ -36,3 +39,6 @@ _If it's a self-hosting setup, specify all packages and versions used in the dis @humany/widget-types-grid@1.0.23 ... ``` + +## Additional details / screenshot +_Provide any additional information about this issue, such as error logs and screenshots._ From d1b9d7511ac35000980aa1bb3440991b8a166243 Mon Sep 17 00:00:00 2001 From: Andreas Brantmo Date: Thu, 20 Aug 2020 09:47:29 +0200 Subject: [PATCH 3/3] Update issue-report-template.md --- docs/issue-report-template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/issue-report-template.md b/docs/issue-report-template.md index 092c4ab..c7a3bcd 100644 --- a/docs/issue-report-template.md +++ b/docs/issue-report-template.md @@ -19,7 +19,7 @@ _If yes, please specify when the bug was introduced (version or date)._ ## Environment ### Link to Widget -_URL to a page where the widget is implemented and where the particular error can be reproduced._ +_URL to a page where the widget is implemented and where the particular error can be reproduced. Ensure the widget is available and not removed until case is closed. ### Link to Repository (optional) _URL to a Git repository where the particular error can be repdocued._