From f6d7ed9d734dfef4f54255ad74c05d0f4b8e17e3 Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Sun, 10 Jul 2022 15:58:28 +0100 Subject: [PATCH] Updates issue templates, YAML style --- .github/ISSUE_TEMPLATE/addition-to-list.md | 27 ---------- .github/ISSUE_TEMPLATE/addition.yml | 56 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 38 -------------- .github/ISSUE_TEMPLATE/removal-from-list.md | 26 ---------- .github/ISSUE_TEMPLATE/removal.yml | 56 +++++++++++++++++++++ 5 files changed, 112 insertions(+), 91 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/addition-to-list.md create mode 100644 .github/ISSUE_TEMPLATE/addition.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/removal-from-list.md create mode 100644 .github/ISSUE_TEMPLATE/removal.yml diff --git a/.github/ISSUE_TEMPLATE/addition-to-list.md b/.github/ISSUE_TEMPLATE/addition-to-list.md deleted file mode 100644 index 579e081..0000000 --- a/.github/ISSUE_TEMPLATE/addition-to-list.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: Addition to List -about: Suggest a point to be added to the list -title: "[CONTENT-CHANGE]" -labels: enhancement -assignees: Lissy93 - ---- - -### Put "Add ____" as Title - -### Explain why it should be added -[A clear and concise description of the point and why it should be added to the list.] - -### Additional Context -[Provide some context, with a bit of detail. Specify which of the 10 categories this point should be listed under] - -### Content (optional) -[Suggest some content, including links, written in clear English for the point you'd like added] - ---- - -### NOTES: -- Before submitting, check that there isn't a similar open issue already -- Please create a new issue for each separate/ stand-alone point you'd like added to the list -- If you are confident in your abilities, you can also write the point yourself, and submit it as a PR -- Thank you for your suggestion, it's because of contributors like yourself that this project can exist diff --git a/.github/ISSUE_TEMPLATE/addition.yml b/.github/ISSUE_TEMPLATE/addition.yml new file mode 100644 index 0000000..daea7f4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/addition.yml @@ -0,0 +1,56 @@ +name: Addition +description: 🆕 Suggest something to be added to the list +title: '[ADDITION] ' +labels: ['Suggested Addition', 'Awaiting Review'] +assignees: + - lissy93 +body: + # Location + - type: input + id: location + attributes: + label: Location + description: >- + Indicate which section (and if applicable sub-section) the addition should be made + placeholder: + validations: + required: true + + # Addition Info + - type: textarea + id: addition + attributes: + label: Addition + description: | + Please describe what should be added + Where applicable, provide links to reputable sources to back up any info + placeholder: + validations: + required: true + + # Can user submit PR + - type: dropdown + id: canImplement + attributes: + label: Would you like to submit a PR? + description: Is this addition something that you are willing to submit a pull request for? + options: + - 'No' + - 'Maybe' + - 'Yes' + validations: + required: false + + + # Confirmation checkboxes + - type: checkboxes + id: idiot-check + attributes: + label: Please tick the boxes + options: + - label: To the best of my knowledge, the information I've provided is correct + required: true + - label: I have checked that a similar ticket has not previously been opened + required: true + - label: I agree to the repositories [Code of Conduct](https://github.com/Lissy93/personal-security-checklist/blob/master/.github/CODE_OF_CONDUCT.md) + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 06afeb7..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[BUG]" -labels: bug -assignees: Lissy93 - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/removal-from-list.md b/.github/ISSUE_TEMPLATE/removal-from-list.md deleted file mode 100644 index 772d653..0000000 --- a/.github/ISSUE_TEMPLATE/removal-from-list.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Removal from List -about: Suggest a point specified should be edited or removed from the list -title: "[CONTENT-CHANGE]" -labels: enhancement -assignees: Lissy93 - ---- - -### State which point should be edited or removed. Put "Remove/ Edit ____" as Title - -### Justification -[A clear and concise justification of why this point is incorrect/ no longer relevant] -or -[A clear and concise explanation of what is not right, and suggest how it should be amended] - -### Additional Context (optional) -[Provide some context, with a bit of detail, and if it is for an edit, you can suggest the new text] - ---- - -### NOTES: -- Before submitting, check that there isn't a similar open issue already -- Please create a new issue for each separate/ stand-alone point you'd like edited/ removed from the list -- If you are confident in your abilities, you can also make the changes yourself, and submit it as a PR -- Thank you for your suggestion, it's because of contributors like yourself that this project can exist diff --git a/.github/ISSUE_TEMPLATE/removal.yml b/.github/ISSUE_TEMPLATE/removal.yml new file mode 100644 index 0000000..93bcde8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/removal.yml @@ -0,0 +1,56 @@ +name: Removal +description: ❌ Suggest something that should be removed from the list +title: '[REMOVAL] <title>' +labels: ['Suggested Removal', 'Awaiting Review'] +assignees: + - lissy93 +body: + # Location + - type: input + id: location + attributes: + label: What should be removed? + description: >- + Indicate which point, and from which section you are referring to + placeholder: + validations: + required: true + + # Removal description + - type: textarea + id: removal + attributes: + label: Justification + description: | + Describe why this should be removed + Where applicable, provide links to reputable sources to back up any info + placeholder: + validations: + required: true + + # Can user submit PR + - type: dropdown + id: canImplement + attributes: + label: Would you like to submit a PR? + description: Is this removal something that you are willing to submit a pull request for? + options: + - 'No' + - 'Maybe' + - 'Yes' + validations: + required: false + + # Confirmation checkboxes + - type: checkboxes + id: idiot-check + attributes: + label: Please tick the boxes + options: + - label: To the best of my knowledge, the information I've provided is correct + required: true + - label: I have checked that a similar ticket has not previously been opened + required: true + - label: I agree to the repositories [Code of Conduct](https://github.com/Lissy93/personal-security-checklist/blob/master/.github/CODE_OF_CONDUCT.md) + required: true +