Skip to content

Commit

Permalink
chore: Create issue templates (#371) (#428)
Browse files Browse the repository at this point in the history
Co-authored-by: Matthieu Jouis <matthieu@probabl.ai>
  • Loading branch information
tuscland and rouk1 authored Oct 3, 2024
1 parent 2241851 commit 5dc4d3e
Show file tree
Hide file tree
Showing 4 changed files with 125 additions and 0 deletions.
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Bug Report
description: Create a report to help us reproduce and correct the bug
labels: ['bug', 'needs-triage']

body:
- type: markdown
attributes:
value: >
#### Before submitting a bug, please make sure the issue hasn't been already
addressed by searching through [the past issues](https://github.com/probabl-ai/skore/issues).
- type: textarea
attributes:
label: Describe the bug
description: >
A clear and concise description of the bug.
validations:
required: true
- type: textarea
attributes:
label: Steps/Code to Reproduce
description: |
Please add a minimal code example that can reproduce the error when running it. Be as succinct as possible, **do not depend on external data files**.
placeholder: |
Describe each step to reproduce the problem, along with related sample code if relevant.
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: >
A clear and concise description of what you expected to happen.
placeholder: >
Example: No error is thrown.
validations:
required: true
- type: textarea
attributes:
label: Actual Behavior
description: |
A clear and concise description of what actually happened. If you observe an error, please paste the error message including the **full traceback** of the exception.
placeholder: >
Please paste or specifically describe the actual output or traceback.
```pytb
Paste here your traceback.
````
validations:
required: true
- type: textarea
attributes:
label: Environment
render: shell
description: |
Please run the following and paste the output below.
```python
import skore; skore.show_versions()
```
validations:
required: true
- type: markdown
attributes:
value: >
Thanks for contributing 🎉!
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: Discord server
url: https://discord.gg/SCknzSQW
about: Developers and users can be found on the Discord server
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/doc_improvement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Documentation improvement
description: Create a report to help us improve the documentation. Alternatively you can just open a pull request with the suggested change.
labels: ['documentation', 'needs-triage']

body:
- type: textarea
attributes:
label: Which part of the documentation needs improvement?
description: >
Provide a link to the documentation page and section, if possible.
validations:
required: true
- type: textarea
attributes:
label: Describe the problem found in the documentation
description: >
Tell us about the confusion introduced in the documentation.
validations:
required: true
- type: textarea
attributes:
label: Suggested improvement
description: >
Tell us how we could improve the documentation in this regard.
- type: textarea
attributes:
label: Additional context
description: >
Add any other context about the documentation improvement here.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Feature request
description: Suggest a new feature, or enhancement to an existing feature.
labels: ['enhancement', 'needs-triage']

body:
- type: textarea
attributes:
label: Is your feature request related to a problem? Please describe.
description: >
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: true
- type: textarea
attributes:
label: Describe the solution you'd like
description: >
A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
attributes:
label: Describe alternatives you've considered, if relevant
description: >
A clear and concise description of any alternative solutions or features you've considered.
- type: textarea
attributes:
label: Additional context
description: >
Add any other context or screenshots about the feature request here.

0 comments on commit 5dc4d3e

Please sign in to comment.