Skip to content

Commit

Permalink
docs: Add issue templates (#109)
Browse files Browse the repository at this point in the history
* docs: Add issue_templates

* fix: Fix link in bug_report

* fix: Fix project name in templates
  • Loading branch information
kvankova authored Nov 7, 2024
1 parent feed5cc commit 0829aa8
Show file tree
Hide file tree
Showing 4 changed files with 82 additions and 1 deletion.
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: '🐛 Bug report'
description: Report an issue with generals-bots.
labels: [bug]

body:
- type: checkboxes
id: checks
attributes:
label: Checks
options:
- label: I have checked that this issue has not already been reported.
required: true
- label: I have confirmed this bug exists on the [latest version](https://github.com/strakam/generals-bots) of generals-bots.
required: true

- type: textarea
id: example
attributes:
label: Reproducible example
description: >
Please follow [this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) on how to
provide a minimal, copy-pasteable example. Include the (wrong) output if applicable.
value: |
```python
```
validations:
required: true

- type: textarea
id: logs
attributes:
label: Log output
description: >
Paste the output of the action run here.
render: shell

- type: textarea
id: problem
attributes:
label: Issue description
description: >
Provide any additional information you think might be relevant.
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: >
Describe or show a code example of the expected behavior.
validations:
required: true
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: '📖 Documentation improvement'
description: Report an issue with the documentation.
labels: [documentation]

body:
- type: textarea
id: description
attributes:
label: Description
description: >
Describe the issue with the documentation and how it can be fixed or improved.
validations:
required: true
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: '✨ Feature request'
description: Suggest a new feature or enhancement for generals-bots.
labels: [enhancement]

body:
- type: textarea
id: description
attributes:
label: Description
description: >
Describe the feature or enhancement and explain why it should be implemented.
Include a code example if applicable.
validations:
required: true
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ This script will run `ExpanderAgent` in the specified lobby.
## 🙌 Contributing
You can contribute to this project in multiple ways:
- 🤖 If you implement ANY non-trivial agent, send it to us! We will publish it, so others can play against it.
- 💡 If you have an idea on how to improve the game, submit an issue or create a PR, we are happy to improve!
- 💡 If you have an idea on how to improve the game, submit an [issue](https://github.com/strakam/generals-bots/issues/new/choose) or create a PR, we are happy to improve!
We also have some ideas (see [issues](https://github.com/strakam/generals-bots/issues)), so you can see what we plan to work on.
> [!Tip]
Expand Down

0 comments on commit 0829aa8

Please sign in to comment.