From fd68d97902fd970b64c6fa7725689ab0b0fd51df Mon Sep 17 00:00:00 2001 From: Stephannie Jimenez Date: Wed, 2 Aug 2023 18:18:42 -0500 Subject: [PATCH 1/3] Add issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 84 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 39 ++++++++++ .github/ISSUE_TEMPLATE/general_issue.yml | 46 ++++++++++++ 3 files changed, 169 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/general_issue.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..299a915c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,84 @@ +name: "Bug report 🐛" +description: "Create a report to help us reproduce and correct the bug" +title: "[BUG] - " +labels: ["type: bug 🐛"] + +body: + - type: markdown + attributes: + value: | + # Welcome 👋 + + Thanks for using Conda Store UI and taking some time to contribute to this project. + + Please fill out each section below. This info allows maintainers to diagnose (and fix!) your issue as + quickly as possible. + Before submitting a bug, please make sure the issue hasn't been already addressed by searching through + the past issues in this repository. + + - type: textarea + attributes: + label: Describe the bug + description: | + A clear and concise description of what the bug is. + We suggest using bullets (indicated by * or -). + placeholder: Be as precise as you can. + validations: + required: true + + - type: textarea + attributes: + label: Expected behavior + description: | + A clear and concise description of what you expected to happen. + We suggest using bullets (indicated by * or -). + validations: + required: true + + - type: textarea + attributes: + label: How to Reproduce the problem? + description: | + Please provide a minimal code example to reproduce the error. + Be as succinct as possible, and provide detailed step by step guidelines to reproduce the bug (using numbered items). + If you have created a GitHub gist, you can paste the link in this box instead. + validations: + required: true + + - type: textarea + attributes: + label: Output + description: | + Provide the output of the steps above, including screenshots and any tracebacks/logs. + + Please also ensure that the "How to reproduce the problem?" section contains matching + instructions for reproducing this. + validations: + required: false + + - type: textarea + attributes: + label: Versions and dependencies used. + description: | + Describe your environment: + - Conda version (use `conda --version`) + - Operating system + - Node version + - Dependencies installed and their version + 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! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false + + - type: markdown + attributes: + value: > + Thanks for contributing 🎉! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..7021c2a4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,39 @@ +name: "Feature request" +description: "Create a feature request to help us improve" +title: "[ENH] - <title>" +labels: ["type: enhancement 💅"] + +body: + - type: markdown + attributes: + value: | + # Welcome 👋 + + Thanks for using Conda Store UI and taking some time to contribute to this project. + - type: textarea + attributes: + label: Feature description + description: | + Describe what you are proposing. Provide as much context as possible and link to related issues and/or pull requests. + This section should contain "what" you are proposing. + Are you having any problems? Briefly describe what your painpoints are. For example: "I'm always frustrated when ..." + validations: + required: true + + - type: textarea + attributes: + label: Value and/or benefit + description: | + What is the value in adding this feature, and who will benefit from it? Include any information that could help us prioritize the issue. + This section should contain "why" this issue should be resolved. + validations: + required: true + + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + 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/ISSUE_TEMPLATE/general_issue.yml b/.github/ISSUE_TEMPLATE/general_issue.yml new file mode 100644 index 00000000..3d167148 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general_issue.yml @@ -0,0 +1,46 @@ +name: "General issue 💡" +description: "A general template for many kinds of issues." +title: "<title>" +labels: ["type: question 🤔"] + +body: + - type: markdown + attributes: + value: | + # Welcome 👋 + + Thanks for using Conda Store UI and taking some time to contribute to this project. + + Please fill out each section below. This info allows maintainers to diagnose (and fix!) your issue as + quickly as possible. + Before submitting a bug, please make sure the issue hasn't been already addressed by searching through + the past issues in this repository. + + - type: textarea + attributes: + label: Context + description: | + Describe what you are proposing. Provide as much context as possible and link to related issues and/or pull requests. + This section should contain "what" you are proposing. + Are you having any problems? Briefly describe what your pain points are. + validations: + required: true + + - type: textarea + attributes: + label: Value and/or benefit + description: | + What is the value of adding this feature, and who will benefit from it? Include any information that could help us prioritize the issue. + This section should contain "why" this issue should be resolved. + validations: + required: true + + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + 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 From 32e53e79c3dfe3a614c312b24a11a37e1fa73530 Mon Sep 17 00:00:00 2001 From: Stephannie Jimenez <steff456@hotmail.com> Date: Thu, 3 Aug 2023 08:19:03 -0500 Subject: [PATCH 2/3] Add pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..1f25003d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,20 @@ +Fixes # . + +## Description +<!-- What is the purpose of this pull request? --> + +This pull request: + +- a +- b +- c + +## Questions +<!-- Any questions for reviewers of this pull request? --> + +No. + +## Other +<!-- Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes. --> + +No. \ No newline at end of file From 887643b88702449faebfbc8b2a5e4bf93a34d6a7 Mon Sep 17 00:00:00 2001 From: Stephannie Jimenez <steff456@hotmail.com> Date: Wed, 9 Aug 2023 11:55:41 -0500 Subject: [PATCH 3/3] Add review changes --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 ++-- .github/ISSUE_TEMPLATE/config.yml | 8 ++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- .github/ISSUE_TEMPLATE/general_issue.yml | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 16 +++++++++------- 5 files changed, 21 insertions(+), 11 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 299a915c..629dd82b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,5 +1,5 @@ name: "Bug report 🐛" -description: "Create a report to help us reproduce and correct the bug" +description: "Create a report to help us fix something that is currently broken." title: "[BUG] - <title>" labels: ["type: bug 🐛"] @@ -9,7 +9,7 @@ body: value: | # Welcome 👋 - Thanks for using Conda Store UI and taking some time to contribute to this project. + Thanks for using conda-store and taking some time to contribute to this project. Please fill out each section below. This info allows maintainers to diagnose (and fix!) your issue as quickly as possible. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..10732a60 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: conda-store-ui documentation + url: https://conda-incubator.github.io/conda-store-ui/ + about: Check out the conda-store documentation + - name: conda-store-ui issue tracker + about: Did you find a bug or want to make a suggestion? Open an issue on our tracker. + url: https://https://github.com/conda-incubator/conda-store-ui/issues/new/choose \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 7021c2a4..8162ce4b 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -9,7 +9,7 @@ body: value: | # Welcome 👋 - Thanks for using Conda Store UI and taking some time to contribute to this project. + Thanks for using conda-store and taking some time to contribute to this project. - type: textarea attributes: label: Feature description diff --git a/.github/ISSUE_TEMPLATE/general_issue.yml b/.github/ISSUE_TEMPLATE/general_issue.yml index 3d167148..f60b2eeb 100644 --- a/.github/ISSUE_TEMPLATE/general_issue.yml +++ b/.github/ISSUE_TEMPLATE/general_issue.yml @@ -9,7 +9,7 @@ body: value: | # Welcome 👋 - Thanks for using Conda Store UI and taking some time to contribute to this project. + Thanks for using conda-store and taking some time to contribute to this project. Please fill out each section below. This info allows maintainers to diagnose (and fix!) your issue as quickly as possible. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1f25003d..8d73abc2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,6 @@ Fixes # . +<!-- Reference the issue corresponding to this PR. If an issues does not exist, consider opening one or writing a detailed descrition for what this PR changes and it's value in the following sections. --> +<!-- GitHub Docs on Keywords: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests --> ## Description <!-- What is the purpose of this pull request? --> @@ -9,12 +11,12 @@ This pull request: - b - c -## Questions -<!-- Any questions for reviewers of this pull request? --> +## Pull request checklist +<!-- Quick checklist to ensure high-quality Pull Request. --> -No. +- [ ] Did you test this change locally? +- [ ] Did you update the documentaion (if required)? +- [ ] Did you add/update relevant tests for this change (if required)? -## Other -<!-- Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes. --> - -No. \ No newline at end of file +## Additional information +<!-- Do you have any other information about this pull request? This may include screenshots, references, and/or implementation notes. -->