Skip to content

Commit

Permalink
MAINT - Update issue and PR templates
Browse files Browse the repository at this point in the history
Update issue and pull request templates
  • Loading branch information
trallard authored Aug 9, 2023
2 parents 48858e7 + 059a9bd commit f0a541b
Show file tree
Hide file tree
Showing 7 changed files with 198 additions and 12 deletions.
7 changes: 0 additions & 7 deletions .github/ISSUE_TEMPLATE/bug-report.md

This file was deleted.

84 changes: 84 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
name: "Bug report 🐛"
description: "Create a report to help us fix something that is currently broken."
title: "[BUG] - <title>"
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 🎉!
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: conda-store documentation
url: https://conda.store/en/latest/
about: Check out the conda-store documentation
- name: conda-store 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/issues/new/choose
5 changes: 0 additions & 5 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -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
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/general-issue.yml
Original file line number Diff line number Diff line change
@@ -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
22 changes: 22 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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. -->

0 comments on commit f0a541b

Please sign in to comment.