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

Added issue templates to help with workflows #807

Merged
merged 3 commits into from
Jan 17, 2024
Merged
Show file tree
Hide file tree
Changes from 2 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
87 changes: 87 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug_template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
name: '🐛 Bug Report'
description: Create a new ticket for a bug.
title: '🐛 [Bug] - <title>'
labels: ['bug']

body:
- type: markdown
attributes:
value: |
### Expected Behavior
---

### Current Behavior
---

### Steps to Reproduce
---

Please try to describe the issue as best as possible

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

- type: input
id: version
attributes:
label: 'FrappeBooks Version'
# description: Please enter your GitHub URL to provide a reproduction of the issue
placeholder: ex. 0.20.0
validations:
required: true

- type: input
id: path_feature_name
attributes:
label: 'Path or Feature name'
description: Please enter the path (i.e. /import-wizard) or Feature name where the bug was seen
placeholder: ex. Import-Wizard
validations:
required: true

- type: input
id: country_code
attributes:
label: 'Country'
description: Please enter the two digit country code for your country (i.e. BR, CH, IN, US)
placeholder: ex. IN
validations:
required: true

- type: input
id: language
attributes:
label: 'Language'
description: Please enter the two digit language code or full lanaguage used in the application
placeholder: ex. EN or english
validations:
required: true

- type: dropdown
id: os
attributes:
label: 'OS'
description: What is the impacted environment ?
multiple: true
options:
- Windows 8
- Windows 8.1
- Windows 10
- Windows 11
- Linux x86_64
- Linux Arm64 (i.e. Raspberry Pi)
- Macos (Intel)
- Macos (Apple Silicon)
validations:
required: true

- type: input
id: additional_os_info
attributes:
label: 'Additional OS Info'
description: Please enter any additional information regarding your OS that may aid in troubleshooting (i.e. Macos 10.14, Ubuntu 20.04, etc)
placeholder: ex. Macos 10.14 / Ubuntu 20.04
validations:
required: false
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature_template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: '💡 Feature Request'
description: Create a new ticket for a new feature request
title: '💡 [Feature Request] - <title>'
labels: ['enhancement']

body:
- type: textarea
id: summary
attributes:
label: 'Summary'
description: Provide a brief explanation of the feature
placeholder: Describe in a few lines your feature request
validations:
required: true
Isaac-GC marked this conversation as resolved.
Show resolved Hide resolved

- type: textarea
id: basic_example
attributes:
label: 'Basic Example'
description: Indicate here some basic examples of your feature.
placeholder: A few specific words about your feature request.
validations:
required: true

- type: textarea
id: drawbacks
attributes:
label: 'Drawbacks'
description: What are the drawbacks/impacts of your feature request ?
placeholder: Identify the drawbacks and impacts while being neutral on your feature request
validations:
required: true

- type: textarea
id: reference_issues
attributes:
label: 'Reference Issues'
description: Common issues
placeholder: '#Issues IDs'
validations:
required: false
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/3-general_question_template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: 'General Question'
description: Create a new ticket for a general question
title: '🐛 [General Question] - <title>'
labels: ['question']

body:
- type: textarea
id: summary
attributes:
label: 'Summary'
description: General Question(s) (for Bugs and Feature Requests, please use the appropriate template)
placeholder: '...'
validations:
required: true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we could make use of the discussions GitHub feature for this.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I figure instead of completely pushing people to github discussions or telegram, we would instead continue giving the ability for questions and then sometime in the future, just get rid of it all together (trying to prevent too much change at once)

Empty file.
Loading