From e682a8ae2d298b47e87a802dfef2bdc7bdc9d886 Mon Sep 17 00:00:00 2001 From: Stephannie Jimenez Gacha Date: Thu, 10 Aug 2023 03:04:14 -0500 Subject: [PATCH] Add issue templates (#260) --- .github/ISSUE_TEMPLATE/bug_report.yml | 84 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++ .github/ISSUE_TEMPLATE/feature_request.yml | 39 ++++++++++ .github/ISSUE_TEMPLATE/general_issue.yml | 46 ++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 22 ++++++ 5 files changed, 199 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/general_issue.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..629dd82b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,84 @@ +name: "Bug report 🐛" +description: "Create a report to help us fix something that is currently broken." +title: "[BUG] - " +labels: ["type: bug 🐛"] + +body: + - type: markdown + attributes: + value: | + # Welcome 👋 + + 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. + 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/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 new file mode 100644 index 00000000..8162ce4b --- /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 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..f60b2eeb --- /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 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 diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..8d73abc2 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,22 @@ +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? --> + +This pull request: + +- a +- b +- c + +## Pull request checklist +<!-- Quick checklist to ensure high-quality Pull Request. --> + +- [ ] Did you test this change locally? +- [ ] Did you update the documentaion (if required)? +- [ ] Did you add/update relevant tests for this change (if required)? + +## Additional information +<!-- Do you have any other information about this pull request? This may include screenshots, references, and/or implementation notes. -->