Skip to content

Commit

Permalink
Add issue template (#56)
Browse files Browse the repository at this point in the history
Signed-off-by: Jael Gu <[email protected]>
  • Loading branch information
jaelgu authored Aug 2, 2023
1 parent 1fd3472 commit 363404c
Show file tree
Hide file tree
Showing 3 changed files with 92 additions and 0 deletions.
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: 🐞 Bug Report
description: Create a bug report to help us improve Akcio
title: "[Bug]: "
labels: [bug, help wanted]
assignees:
- jaelgu
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! Please fill the form in English!
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
placeholder: |
When I do <X>, <Y> happens and I see the error message attached below:
```...```
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
placeholder: When I do <X>, <Z> should happen instead.
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...
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

5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Slack link
url: https://slack.towhee.io/
about: Ask a question or chat with the Towhee community
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Enhancement Request
description: I want to request a feature or suggest an enhancement for Akcio
title: "[Enhancement]:"
labels: [enhancement]
assignees:
- jaelgu
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to request/suggest an enhancement for Akcio! Please fill the form in English!
- type: textarea
attributes:
label: What would you like to be added?
description: A concise description of what you're expecting/suggesting.
placeholder: |
I would like to suggest/request a feature that's like...
validations:
required: false
- type: textarea
attributes:
label: Why is this needed?
description: A concise description of the reason/motivation
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about this!
validations:
required: false

0 comments on commit 363404c

Please sign in to comment.