From 4ca356a72b06b7df2c57a60da5b3f67792071435 Mon Sep 17 00:00:00 2001 From: Lars Reimann Date: Sun, 19 Jun 2022 17:05:37 +0200 Subject: [PATCH 1/9] chore: issue template for missing annotations --- .github/ISSUE_TEMPLATE/missing_annotation.yml | 53 +++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/missing_annotation.yml diff --git a/.github/ISSUE_TEMPLATE/missing_annotation.yml b/.github/ISSUE_TEMPLATE/missing_annotation.yml new file mode 100644 index 000000000..126d42598 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/missing_annotation.yml @@ -0,0 +1,53 @@ +name: "Missing annotation (autogen)" +description: "An annotation should have been generated automatically but wasn't." +title: "" +labels: ["bug", "missing annotation"] + +body: + - type: input + id: url-hash + attributes: + label: URL Hash + description: Copy the part of the URL that starts with `#` from the address bar of your browser. + placeholder: ex. #/sklearn/sklearn.metrics + validations: + required: true + + - type: dropdown + id: expected-annotation-type + attributes: + label: Expected Annotation Type + description: Which annotation did you expect to be generated automatically? + options: + - @boundary + - @constant + - @enum + - @optional + - @remove + - @required + validations: + required: true + + - type: textarea + id: expected-annotation-inputs + attributes: + label: Expected Annotation Inputs + description: Which inputs did you expect the annotation to have? + validations: + required: false + + - type: textarea + id: suggested-solution + attributes: + label: Suggested Solution + description: Do you already have an idea how this problem could be fixed? + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Do you have anything else to add? + validations: + required: false From 6c89f291cb415a6f079da0cc9d1152d968b2b380 Mon Sep 17 00:00:00 2001 From: Lars Reimann Date: Sun, 19 Jun 2022 17:06:53 +0200 Subject: [PATCH 2/9] chore: fix syntax error --- .github/ISSUE_TEMPLATE/missing_annotation.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/missing_annotation.yml b/.github/ISSUE_TEMPLATE/missing_annotation.yml index 126d42598..13450b783 100644 --- a/.github/ISSUE_TEMPLATE/missing_annotation.yml +++ b/.github/ISSUE_TEMPLATE/missing_annotation.yml @@ -19,12 +19,12 @@ body: label: Expected Annotation Type description: Which annotation did you expect to be generated automatically? options: - - @boundary - - @constant - - @enum - - @optional - - @remove - - @required + - "@boundary" + - "@constant" + - "@enum" + - "@optional" + - "@remove" + - "@required" validations: required: true From e91196b88eef5b7222b8834b9753c80afdfa4618 Mon Sep 17 00:00:00 2001 From: Lars Reimann Date: Sun, 19 Jun 2022 17:07:25 +0200 Subject: [PATCH 3/9] chore: remove empty title --- .github/ISSUE_TEMPLATE/missing_annotation.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/missing_annotation.yml b/.github/ISSUE_TEMPLATE/missing_annotation.yml index 13450b783..09e4278d6 100644 --- a/.github/ISSUE_TEMPLATE/missing_annotation.yml +++ b/.github/ISSUE_TEMPLATE/missing_annotation.yml @@ -1,6 +1,5 @@ name: "Missing annotation (autogen)" description: "An annotation should have been generated automatically but wasn't." -title: "" labels: ["bug", "missing annotation"] body: From 346f17b02f18d8bb4425c23e9cb4bf06b53e5c4a Mon Sep 17 00:00:00 2001 From: Lars Reimann Date: Sun, 19 Jun 2022 17:08:30 +0200 Subject: [PATCH 4/9] chore: fix placeholder? --- .github/ISSUE_TEMPLATE/missing_annotation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/missing_annotation.yml b/.github/ISSUE_TEMPLATE/missing_annotation.yml index 09e4278d6..3eea00b78 100644 --- a/.github/ISSUE_TEMPLATE/missing_annotation.yml +++ b/.github/ISSUE_TEMPLATE/missing_annotation.yml @@ -8,7 +8,7 @@ body: attributes: label: URL Hash description: Copy the part of the URL that starts with `#` from the address bar of your browser. - placeholder: ex. #/sklearn/sklearn.metrics + placeholder: ex. `#/sklearn/sklearn.metrics` validations: required: true From 4374137b5e3d4bb194ed6b005ca74ce0a3df9dcb Mon Sep 17 00:00:00 2001 From: Lars Reimann Date: Sun, 19 Jun 2022 17:09:55 +0200 Subject: [PATCH 5/9] chore: fix placeholder --- .github/ISSUE_TEMPLATE/missing_annotation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/missing_annotation.yml b/.github/ISSUE_TEMPLATE/missing_annotation.yml index 3eea00b78..7f1b6490b 100644 --- a/.github/ISSUE_TEMPLATE/missing_annotation.yml +++ b/.github/ISSUE_TEMPLATE/missing_annotation.yml @@ -8,7 +8,7 @@ body: attributes: label: URL Hash description: Copy the part of the URL that starts with `#` from the address bar of your browser. - placeholder: ex. `#/sklearn/sklearn.metrics` + placeholder: "ex. #/sklearn/sklearn.metrics" validations: required: true From 7fe058437c3f97a3551f4e990ba3c9d3470d16d0 Mon Sep 17 00:00:00 2001 From: Lars Reimann Date: Sun, 19 Jun 2022 17:10:49 +0200 Subject: [PATCH 6/9] chore: minor improvements --- .github/ISSUE_TEMPLATE/missing_annotation.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/missing_annotation.yml b/.github/ISSUE_TEMPLATE/missing_annotation.yml index 7f1b6490b..4bc0143dd 100644 --- a/.github/ISSUE_TEMPLATE/missing_annotation.yml +++ b/.github/ISSUE_TEMPLATE/missing_annotation.yml @@ -33,12 +33,12 @@ body: label: Expected Annotation Inputs description: Which inputs did you expect the annotation to have? validations: - required: false + required: true - type: textarea id: suggested-solution attributes: - label: Suggested Solution + label: Suggested Solution (optional) description: Do you already have an idea how this problem could be fixed? validations: required: false @@ -46,7 +46,7 @@ body: - type: textarea id: additional-context attributes: - label: Additional Context + label: Additional Context (optional) description: Do you have anything else to add? validations: required: false From a465b1c2284a849aa7e751e8b907b5cf348a37d5 Mon Sep 17 00:00:00 2001 From: Lars Reimann Date: Sun, 19 Jun 2022 17:15:43 +0200 Subject: [PATCH 7/9] chore: issue template for wrong annotations --- .github/ISSUE_TEMPLATE/wrong_annotation | 75 +++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/wrong_annotation diff --git a/.github/ISSUE_TEMPLATE/wrong_annotation b/.github/ISSUE_TEMPLATE/wrong_annotation new file mode 100644 index 000000000..ee66950ca --- /dev/null +++ b/.github/ISSUE_TEMPLATE/wrong_annotation @@ -0,0 +1,75 @@ +name: "Wrong annotation (autogen)" +description: "An annotation was generated automatically but is incorrect." +labels: ["bug", "wrong annotation"] + +body: + - type: input + id: url-hash + attributes: + label: URL Hash + description: Copy the part of the URL that starts with `#` from the address bar of your browser. + placeholder: "ex. #/sklearn/sklearn.metrics" + validations: + required: true + + - type: dropdown + id: actual-annotation-type + attributes: + label: Actual Annotation Type + description: Which annotation was generated automatically? + options: + - "@boundary" + - "@constant" + - "@enum" + - "@optional" + - "@remove" + - "@required" + validations: + required: true + + - type: textarea + id: actual-annotation-inputs + attributes: + label: Actual Annotation Inputs + description: Which inputs did the automatically generated annotation have? + validations: + required: true + + - type: dropdown + id: expected-annotation-type + attributes: + label: Expected Annotation Type + description: Which annotation did you expect to be generated automatically? + options: + - "@boundary" + - "@constant" + - "@enum" + - "@optional" + - "@remove" + - "@required" + validations: + required: true + + - type: textarea + id: expected-annotation-inputs + attributes: + label: Expected Annotation Inputs + description: Which inputs did you expect the annotation to have? + validations: + required: true + + - type: textarea + id: suggested-solution + attributes: + label: Suggested Solution (optional) + description: Do you already have an idea how this problem could be fixed? + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Additional Context (optional) + description: Do you have anything else to add? + validations: + required: false From b0e2a6f4de787e49bdbd3abd5f6a04ef4cb31c5d Mon Sep 17 00:00:00 2001 From: Lars Reimann Date: Sun, 19 Jun 2022 17:16:01 +0200 Subject: [PATCH 8/9] Rename wrong_annotation to wrong_annotation.yml --- .github/ISSUE_TEMPLATE/{wrong_annotation => wrong_annotation.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/ISSUE_TEMPLATE/{wrong_annotation => wrong_annotation.yml} (100%) diff --git a/.github/ISSUE_TEMPLATE/wrong_annotation b/.github/ISSUE_TEMPLATE/wrong_annotation.yml similarity index 100% rename from .github/ISSUE_TEMPLATE/wrong_annotation rename to .github/ISSUE_TEMPLATE/wrong_annotation.yml From 93177fab83c210728429135b2498959a605b55dc Mon Sep 17 00:00:00 2001 From: lars-reimann Date: Sun, 19 Jun 2022 15:23:40 +0000 Subject: [PATCH 9/9] style: apply automatic fixes of linters --- .github/ISSUE_TEMPLATE/missing_annotation.yml | 18 +++++------ .github/ISSUE_TEMPLATE/wrong_annotation.yml | 32 +++++++++---------- 2 files changed, 25 insertions(+), 25 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/missing_annotation.yml b/.github/ISSUE_TEMPLATE/missing_annotation.yml index 4bc0143dd..59834dd78 100644 --- a/.github/ISSUE_TEMPLATE/missing_annotation.yml +++ b/.github/ISSUE_TEMPLATE/missing_annotation.yml @@ -1,6 +1,6 @@ -name: "Missing annotation (autogen)" +name: 'Missing annotation (autogen)' description: "An annotation should have been generated automatically but wasn't." -labels: ["bug", "missing annotation"] +labels: ['bug', 'missing annotation'] body: - type: input @@ -8,7 +8,7 @@ body: attributes: label: URL Hash description: Copy the part of the URL that starts with `#` from the address bar of your browser. - placeholder: "ex. #/sklearn/sklearn.metrics" + placeholder: 'ex. #/sklearn/sklearn.metrics' validations: required: true @@ -18,12 +18,12 @@ body: label: Expected Annotation Type description: Which annotation did you expect to be generated automatically? options: - - "@boundary" - - "@constant" - - "@enum" - - "@optional" - - "@remove" - - "@required" + - '@boundary' + - '@constant' + - '@enum' + - '@optional' + - '@remove' + - '@required' validations: required: true diff --git a/.github/ISSUE_TEMPLATE/wrong_annotation.yml b/.github/ISSUE_TEMPLATE/wrong_annotation.yml index ee66950ca..8eeb1e05a 100644 --- a/.github/ISSUE_TEMPLATE/wrong_annotation.yml +++ b/.github/ISSUE_TEMPLATE/wrong_annotation.yml @@ -1,6 +1,6 @@ -name: "Wrong annotation (autogen)" -description: "An annotation was generated automatically but is incorrect." -labels: ["bug", "wrong annotation"] +name: 'Wrong annotation (autogen)' +description: 'An annotation was generated automatically but is incorrect.' +labels: ['bug', 'wrong annotation'] body: - type: input @@ -8,7 +8,7 @@ body: attributes: label: URL Hash description: Copy the part of the URL that starts with `#` from the address bar of your browser. - placeholder: "ex. #/sklearn/sklearn.metrics" + placeholder: 'ex. #/sklearn/sklearn.metrics' validations: required: true @@ -18,12 +18,12 @@ body: label: Actual Annotation Type description: Which annotation was generated automatically? options: - - "@boundary" - - "@constant" - - "@enum" - - "@optional" - - "@remove" - - "@required" + - '@boundary' + - '@constant' + - '@enum' + - '@optional' + - '@remove' + - '@required' validations: required: true @@ -41,12 +41,12 @@ body: label: Expected Annotation Type description: Which annotation did you expect to be generated automatically? options: - - "@boundary" - - "@constant" - - "@enum" - - "@optional" - - "@remove" - - "@required" + - '@boundary' + - '@constant' + - '@enum' + - '@optional' + - '@remove' + - '@required' validations: required: true