Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the issue templates #2225

Merged
merged 1 commit into from
Apr 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

81 changes: 81 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_issue_template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
name: 🐞 Bug Report
description: Is something broken? Create a report to help us fix it!
title: "[BUG]: <title>"
labels: ["🐞 Bug"]
body:
- type: markdown
attributes:
value: |
# Thank you for taking the time to help us improve the app!
- 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.
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false
- 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...
validations:
required: false
- type: textarea
attributes:
label: Environment
description: |
examples:
- **OS**: Ubuntu 20.04
- **Node**: 13.14.0
- **npm**: 7.6.3
value: |
- OS:
- Node:
- npm:
render: markdown
validations:
required: false
- type: textarea
attributes:
label: Criteria for Completion
description: This should be a bulleted list of items that, if satisfied, would result in an acceptably complete Pull Request. Be as specific as you need to be.
placeholder: |
- [ ] When a user clicks on {this} it should now do {that}
- [ ] This feature should only be available to organization admins
- [ ] Add a test proving that it works
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: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/ifmeorg/ifme/blob/main/code_of_conduct.md)
options:
- label: I've read the Code of Conduct and understand my responsibilities as a member of the if-me community
required: true
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/docs_issue_template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: 📄 Documentation Change
description: Fix and add to the app's documentation
title: "[DOCS]: <title>"
body:
- type: markdown
attributes:
value: |
# Thank you for taking the time to help us improve the app!
- type: checkboxes
attributes:
label: Is there an existing request for this change?
description: Please search to see if a request already exists for the documentation change you'd like to implement.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Context for documentation change
description: Explain the conditions which led you to write this issue
placeholder: |
I noticed unclear explanation of build and install and encountered a few issues while attempting it myself. This could confuse other contributors.
validations:
required: true
- type: textarea
attributes:
label: Proposed solution
description: What would the solution and its criteria look like?
placeholder: |
Contributing needs an expanded section detailing how to install and a section for troubleshooting. Be as specific as you need to be.
validations:
required: false
- type: textarea
attributes:
label: Resources that can help
description: |
Include any documents, images, tutorials, etc that can help the problem be solved.

Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
placeholder: |
- A link to a stack overflow thread describing the issue.
- A screenshot of the error and how people can work through it.
validations:
required: false
- type: textarea
attributes:
label: Collaborators
description: |
Include anyone who may be relevant to the discussion by mentioning them via their GitHub user name.
placeholder: |
@some-user do you have any thoughts here?
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/ifmeorg/ifme/blob/main/code_of_conduct.md)
options:
- label: I've read the Code of Conduct and understand my responsibilities as a member of the if-me community
required: true
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request_template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: ✨ Feature Request
description: Suggest an idea for the app
title: "[FEAT]: <title>"
body:
- type: markdown
attributes:
value: |
# Thank you for taking the time to help us improve the app!
- type: checkboxes
attributes:
label: Is there an existing request for this feature?
description: Please search to see if a request already exists for the feature you'd like.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Is there a pain point in the app driving this feature request?
description: Describe any problems/annoyances you're experiencing in the app.
placeholder: |
When I click on this button, it always takes me back to the beginning instead of...
validations:
required: false
- type: textarea
attributes:
label: Desired Behavior
description: A concise description of what you'd like to experience differently in the app.
validations:
required: false
- type: textarea
attributes:
label: Criteria for Completion
description: This should be a bulleted list of items that, if satisfied, would result in an acceptably complete Pull Request. Be as specific as you need to be.
placeholder: |
- [ ] When a user clicks on {this} it should now do {that}
- [ ] This feature should only be available to organization admins
- [ ] Add a test proving that it works
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the feature you are requesting - propose your solutions here!

Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/ifmeorg/ifme/blob/main/code_of_conduct.md)
options:
- label: I've read the Code of Conduct and understand my responsibilities as a member of the if-me community
required: true