Skip to content

Commit

Permalink
ci: make better issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
lucashervier committed Jul 18, 2023
1 parent 1c8e1eb commit adc363b
Show file tree
Hide file tree
Showing 5 changed files with 171 additions and 84 deletions.
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

86 changes: 86 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
name: Bug Report
description: Create a report to help us improve
title: "[Bug]: - Your issue"
labels: ["bug", "triage"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: dropdown
id: module
attributes:
label: Module
description: Select the modules to which the bug refers.
options:
- Attributions Methods
- Feature Visualization
- Concepts
- Metrics
- Documentation
validations:
required: false
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. email@example.com
validations:
required: false
- type: textarea
attributes:
label: Current Behavior
description: A clear and concise description of what the bug is.
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: true
- type: dropdown
id: version
attributes:
label: Version
description: What version of Xplique are you running?
options:
- v1.1.0
- v1.0.0
- v0.4.3
- v0.2-alpha
- v0.1-alpha
validations:
required: true
- type: textarea
attributes:
label: Environment
description: |
examples:
- **OS**: linux
- **Python version**: 3.7
- **Packages used version**: Tensorflow, Numpy, scikit-learn, etc..
value: |
- OS:
- Python version:
- Tensorflow version:
- Packages used version:
render: markdown
validations:
required: false
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: textarea
attributes:
label: To Reproduce
description: Steps to reproduce the behavior. Even better if you can provide a **minimal** working example to reproduce the behavior or exemple of code to reproduce the bug.
validations:
required: true
26 changes: 0 additions & 26 deletions .github/ISSUE_TEMPLATE/feature-request-enhancement-suggestion.md

This file was deleted.

20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

85 changes: 85 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
name: Feature Request
description: Propose new features / Suggest an idea, modification for this project
title: "[Feature Request]: - Your request"
labels: ["enhancement", "new features"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this request!
- type: dropdown
id: module
attributes:
label: Request
description: Select the kind of request.
options:
- New feature(s)
- Enhance existing feature(s)
- New idea
validations:
required: true
- type: dropdown
id: module
attributes:
label: Module
description: Select the modules to which the request refers.
options:
- Attributions Methods
- Feature Visualization
- Concepts
- Metrics
- Documentation
- Others
validations:
required: true
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. email@example.com
validations:
required: false
- type: textarea
attributes:
label: Feature Request
description: A clear and concise description of your need.
placeholder: Tell us what you want!
value: "One million dollar"
validations:
required: true
- type: textarea
attributes:
label: A minimal example
description: A minimal example. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: dropdown
id: version
attributes:
label: Version
description: What version of Xplique are you running?
options:
- v1.1.0
- v1.0.0
- v0.4.3
- v0.2-alpha
- v0.1-alpha
validations:
required: true
- type: textarea
attributes:
label: Environment
description: |
examples:
- **OS**: linux
- **Python version**: 3.7
- **Packages used version**: Tensorflow, Numpy, scikit-learn, etc..
value: |
- OS:
- Python version:
- Tensorflow version:
- Packages used version:
render: markdown
validations:
required: false

0 comments on commit adc363b

Please sign in to comment.