Skip to content

Commit

Permalink
feat: add bug report and feature request issue templates
Browse files Browse the repository at this point in the history
chore(deps-dev): bump ruff from 0.7.3 to 0.7.4
  • Loading branch information
gylfirst committed Nov 20, 2024
1 parent 22d8f29 commit ed10e57
Show file tree
Hide file tree
Showing 3 changed files with 114 additions and 1 deletion.
72 changes: 72 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: Bug report
description: Report a bug to help us improve the bot
title: "[BUG] Concise description of the issue"
labels: bug
assignees:
- Zalk0
- gylfirst

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: input
id: title
attributes:
label: Bug Title
description: A clear and concise title of what the bug is.
placeholder: Bug title

- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of what the bug is.
placeholder: Describe the bug

- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: |
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
placeholder: Steps to reproduce the bug

- type: textarea
id: expected
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
placeholder: Expected behavior

- type: textarea
id: actual
attributes:
label: Actual behavior
description: A clear and concise description of what actually happened.
placeholder: Actual behavior

- type: input
id: environment
attributes:
label: Environment
description: |
Provide details about the environment running the bot:
- OS and version: [e.g. Windows, MacOS, Linux]
- Technology: [e.g. Docker, Git clone]
- Python version: [e.g. 3.9.5] (if not using Docker)
- Bot version [e.g. Docker image tag or git commit hash]
placeholder: Environment details

- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context about the problem here.
placeholder: Additional context
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Feature request
description: Suggest an idea for this project
title: "[Feature Request]: Concise description of the feature"
labels: enhancement
assignees:
- Zalk0
- gylfirst

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to open a feature request! Please provide us with the following information:
- type: input
id: feature
attributes:
label: Feature description
description: A clear and concise description of what the feature is.
placeholder: Describe the feature you would like to see

- type: textarea
id: motivation
attributes:
label: Motivation
description: Please explain why this feature should be implemented and how it would be used.
placeholder: Explain the motivation behind this feature request

- type: textarea
id: alternatives
attributes:
label: Alternatives
description: Describe any alternative solutions or features you've considered.
placeholder: Describe any alternative solutions or features

- type: input
id: additional-context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
placeholder: Add any other context or screenshots
2 changes: 1 addition & 1 deletion requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
-r requirements.txt
pre-commit ~= 4.0
ruff == 0.7.3
ruff == 0.7.4

0 comments on commit ed10e57

Please sign in to comment.