From fa99e13c656d9aa70fbec9585ab53cbcb4649b65 Mon Sep 17 00:00:00 2001 From: Dipanshu Gupta Date: Fri, 15 Sep 2023 16:49:05 +0530 Subject: [PATCH] Adding issue and pr templates to Github --- .github/ISSUE_TEMPLATE/bug_report.yaml | 68 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yaml | 25 ++++++++ .github/pull_request_template.md | 28 +++++++++ 3 files changed, 121 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 000000000..f4a2bcca1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,68 @@ +name: Bug Report +description: File a bug report. +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! Please, fill this form to help us improve the project. + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true + - type: dropdown + id: version + attributes: + label: Version + description: What was the version this was found on? + multiple: true + options: + - ISPN 15 + - ISPN 14 + - Downstream version + validations: + required: true + - type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: true + - type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: true + - type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + - type: dropdown + id: browsers + attributes: + label: What browsers are you seeing the problem on? + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge + validations: + required: false + - type: textarea + id: anything-else + attributes: + label: Anything else + description: Any additional information you'd like to share + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 000000000..b07e5d894 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,25 @@ +name: Feature request +description: Suggest an idea for this project. +title: "[Feature Request]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature request! Please, fill this form to help us improve the project. + - type: textarea + id: description + attributes: + label: Feature description + description: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Add any other context or screenshots about the feature request here. + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..9c6334c84 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,28 @@ + + + + +## Description + + + +## How Has This Been Tested? + + + + +## Test Impact + + + +## Request review criteria: + + + +Self checklist (all need to be checked): +- [ ] The developer has manually tested the changes and verified that the changes work. +- [ ] Commit message includes a reference to the corresponding JIRA issue (eg. commit message: "ISPN-1234 JIRA TITLE..."). +- [ ] Commits have been squashed and self-contained units of work (e.g. 'WIP' and 'Implements feedback' style messages have been removed). +- [ ] Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious). +- [ ] The developer has added tests or explained why testing cannot be added. +- [ ] Included any necessary screenshots or gifs if it was a UI change. \ No newline at end of file