From e5f0c2f61a5e83d65ef36285c76be88490273692 Mon Sep 17 00:00:00 2001 From: Andreas Nedbal Date: Mon, 30 Jan 2023 22:07:09 +0100 Subject: [PATCH 1/4] Add issue templates --- .github/ISSUE_TEMPLATE/01-bug_report.yml | 55 +++++++++++++++++++ .github/ISSUE_TEMPLATE/02-feature_request.yml | 20 +++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ 3 files changed, 80 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/01-bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/02-feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/01-bug_report.yml b/.github/ISSUE_TEMPLATE/01-bug_report.yml new file mode 100644 index 00000000..777e5a6a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-bug_report.yml @@ -0,0 +1,55 @@ +name: Bug Report +description: If something isn't working as expected +labels: [bug] +body: + - type: markdown + attributes: + value: | + Before opening an issue, make sure to check if the issue was not previously reported or fixed. + - type: textarea + attributes: + label: Steps to reproduce the problem + description: What were you trying to do? + value: | + 1. + 2. + 3. + ... + validations: + required: true + - type: textarea + attributes: + label: Expected behaviour + description: What should have happened? + validations: + required: true + - type: textarea + attributes: + label: Actual behaviour + description: What happened? + validations: + required: true + - type: textarea + attributes: + label: Detailed description + validations: + required: false + - type: textarea + attributes: + label: Specifications + description: | + If you host Retrospring, what version/commit hash of Retrospring did this issue occur in? + + If a front-end issue, what browser and operating systems were you using? + placeholder: | + Retrospring 1970.0101.0 + Ruby 3.1.3 + Node.js 18.13.0 + + Google Chrome 112 + Firefox 109.0 + Internet Explorer 11 + + etc... + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/02-feature_request.yml b/.github/ISSUE_TEMPLATE/02-feature_request.yml new file mode 100644 index 00000000..c4ad2a3f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-feature_request.yml @@ -0,0 +1,20 @@ +name: Feature Request +description: If you have a suggestion +labels: [suggestion] +body: + - type: markdown + attributes: + value: | + Please use a concise and distinct title for the issue. + - type: textarea + attributes: + label: Pitch + description: Describe your idea for a feature. Make sure it has not already been suggested/implemented/turned down before. + validations: + required: true + - type: textarea + attributes: + label: Motivation + description: Why do you think this feature is needed? Who would benefit from it? + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..2d671adb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: GitHub Discussions + url: https://github.com/retrospring/retrospring/discussions + about: Please ask and answer questions here. From d991188c195dec6e29d3e3dc76c74ce6eb79acd7 Mon Sep 17 00:00:00 2001 From: Andreas Nedbal Date: Mon, 30 Jan 2023 22:07:36 +0100 Subject: [PATCH 2/4] Add security policy --- SECURITY.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 SECURITY.md diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..0bef6de2 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,13 @@ +# Security Policy + +If you believe you've found a security vulnerability in Retrospring (a bug that allows something to happen that shouldn't be possible), you can reach us at . + +You should *not* report such issues on GitHub or in other public spaces to give us time to publish a fix for the issue without exposing Retrospring's users to increased risk. + +## Scope + +A "vulnerability in Retrospring" is a vulnerability in the code distributed through our main source code repository on GitHub. Vulnerabilities that are specific to a given installation (e.g. misconfiguration) should be reported to the owner of that installation and not us. + +## Supported Versions + +As long as Retrospring is in rapid development pace the currently supported version for security issues is always the [latest tagged release](https://github.com/Retrospring/retrospring/releases/latest). From 184cd680eb3db8e4f27e7cad4aff2c2c424005e7 Mon Sep 17 00:00:00 2001 From: Andreas Nedbal Date: Tue, 31 Jan 2023 21:45:16 +0100 Subject: [PATCH 3/4] Apply review suggestion --- .github/ISSUE_TEMPLATE/01-bug_report.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/01-bug_report.yml b/.github/ISSUE_TEMPLATE/01-bug_report.yml index 777e5a6a..95d75142 100644 --- a/.github/ISSUE_TEMPLATE/01-bug_report.yml +++ b/.github/ISSUE_TEMPLATE/01-bug_report.yml @@ -48,7 +48,6 @@ body: Google Chrome 112 Firefox 109.0 - Internet Explorer 11 etc... validations: From d442324d3e84f03c0175a16f3cc1ccd1ca31272c Mon Sep 17 00:00:00 2001 From: Andreas Nedbal Date: Tue, 31 Jan 2023 21:46:11 +0100 Subject: [PATCH 4/4] Apply suggestions from code review Co-authored-by: Karina Kwiatek <6197148+raccube@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/01-bug_report.yml | 2 +- .github/ISSUE_TEMPLATE/02-feature_request.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/01-bug_report.yml b/.github/ISSUE_TEMPLATE/01-bug_report.yml index 95d75142..28e87489 100644 --- a/.github/ISSUE_TEMPLATE/01-bug_report.yml +++ b/.github/ISSUE_TEMPLATE/01-bug_report.yml @@ -5,7 +5,7 @@ body: - type: markdown attributes: value: | - Before opening an issue, make sure to check if the issue was not previously reported or fixed. + Before opening an issue, please make sure to check if the [issue tracker](https://github.com/Retrospring/retrospring/issues?q=is%3Aissue+label%3Abug) in case it has been previously reported or fixed. - type: textarea attributes: label: Steps to reproduce the problem diff --git a/.github/ISSUE_TEMPLATE/02-feature_request.yml b/.github/ISSUE_TEMPLATE/02-feature_request.yml index c4ad2a3f..0d81c05b 100644 --- a/.github/ISSUE_TEMPLATE/02-feature_request.yml +++ b/.github/ISSUE_TEMPLATE/02-feature_request.yml @@ -9,7 +9,7 @@ body: - type: textarea attributes: label: Pitch - description: Describe your idea for a feature. Make sure it has not already been suggested/implemented/turned down before. + description: Describe your idea for a feature. Please check our [issue tracker](https://github.com/Retrospring/retrospring/issues?q=is%3Aissue+label%3Asuggestion) to make sure it has not already been suggested/implemented/turned down before. validations: required: true - type: textarea