From 149f05e3e54de6525d73ce5de61d9b18a7acfe42 Mon Sep 17 00:00:00 2001 From: Siddharth Date: Mon, 4 Oct 2021 16:37:14 +0530 Subject: [PATCH] ft:Github PR and Issue Template Added --- .github/ISSUE_TEMPLATE/--bug-report.yaml | 58 +++++++++++++++++++ .../--documentation-improvement.yaml | 40 +++++++++++++ .github/ISSUE_TEMPLATE/--feature-request.yaml | 33 +++++++++++ .../ISSUE_TEMPLATE/--general-question.yaml | 22 +++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/pull_request_template.md | 39 +++++++++++++ 6 files changed, 193 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/--bug-report.yaml create mode 100644 .github/ISSUE_TEMPLATE/--documentation-improvement.yaml create mode 100644 .github/ISSUE_TEMPLATE/--feature-request.yaml create mode 100644 .github/ISSUE_TEMPLATE/--general-question.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml 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 0000000..6a70bca --- /dev/null +++ b/.github/ISSUE_TEMPLATE/--bug-report.yaml @@ -0,0 +1,58 @@ +name: 🐞 Bug report +description: Create a bug report to help us improve idx-auto-tester +title: "[BUG]: " +body: +- type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! +- 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: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + placeholder: | + When I do , happens and I see the error message attached below: + ```...``` + validations: + required: false +- type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + placeholder: When I do , should happen instead. + validations: + required: false +- type: textarea + attributes: + label: Steps To Reproduce + description: Add steps to reproduce this behaviour, include console logs & screenshots + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + render: markdown + validations: + required: false +- type: textarea + attributes: + label: Environment + description: | + Enter the Environment Details: + render: markdown + validations: + required: false +- type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/--documentation-improvement.yaml b/.github/ISSUE_TEMPLATE/--documentation-improvement.yaml new file mode 100644 index 0000000..d859593 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/--documentation-improvement.yaml @@ -0,0 +1,40 @@ +name: 📖 Documentation Improvement +description: Suggest improvements to our documentation +title: "[DOCS]: " +body: +- type: markdown + attributes: + value: | + Thanks for taking the time to fill out this documentation improvement request! +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue realated to this already exists. + options: + - label: I have searched the existing issues + required: true +- type: textarea + attributes: + label: Documentation Link + description: Add a link to the page which needs improvement (if relevant) + validations: + required: false +- type: textarea + attributes: + label: Describe the problem + description: Is the documentation missing? Or is it confusing? Why is it confusing? + validations: + required: false +- type: textarea + attributes: + label: Describe the improvement + description: A clear and concise description of the improvement. + validations: + required: false +- type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + 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 0000000..901baa2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/--feature-request.yaml @@ -0,0 +1,33 @@ +name: 🛠️ Feature request +description: Suggest an idea to improve idx-auto-tester +title: "[FEATURE]: " +body: +- type: markdown + attributes: + value: | + Thanks for taking the time to request a feature for idx-auto-tester! +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue related to this feature request already exists. + options: + - label: I have searched the existing issues + required: true +- type: textarea + attributes: + label: Summary + description: One paragraph description of the feature. + validations: + required: false +- type: textarea + attributes: + label: Why should this be worked on? What problems or use cases does it solve or improve? + description: A concise description of the problem you are facing or the motivation behind this feature request. + validations: + required: false +- type: textarea + attributes: + label: Anything else? + description: Any other context or screenshots that you pertain to the feature. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/--general-question.yaml b/.github/ISSUE_TEMPLATE/--general-question.yaml new file mode 100644 index 0000000..33a0b89 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/--general-question.yaml @@ -0,0 +1,22 @@ +name: 🤔 General question +description: Ask a general question about idx-auto-tester +title: "[QUESTION]: " +body: +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue related to this exists. + options: + - label: I have searched the existing issues + required: true +- type: textarea + attributes: + label: What is your question? + validations: + required: false +- type: textarea + attributes: + label: Anything else? + description: Add any other context, code examples, or references about the question? + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..111f2df --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,39 @@ +> Pull Request Template +> +> Use this template to quickly create a well written pull request. Delete all quotes before creating the pull request. + +## Description + +> Please include a summary of the changes and which issue has been fixed. Please also include relevant motivation +> and context. List any dependencies that are required for this change. + +Fixes # (issue) + +> if no issue exists, please create an issue and ask the maintainers about this first + +## Type of change + +> Please delete options that are not relevant. + +- Bug fix (non-breaking change which fixes an issue) +- New feature (non-breaking change which adds functionality) +- Breaking change (fix or feature that would cause existing functionality to not work as expected) +- This change requires a documentation update + +## How Has This Been Tested? + +> Please describe the tests that you ran to verify your changes. Provide instructions, so we can reproduce. +> Please also list any relevant details for your test configuration. + +- Test A +- Test B + +## Checklist: + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes \ No newline at end of file