mirror of
https://github.com/pufereq/python-template.git
synced 2025-12-15 07:39:32 +00:00
docs: add issue templates
This commit is contained in:
94
.github/ISSUE_TEMPLATE/BUG.yaml
vendored
Normal file
94
.github/ISSUE_TEMPLATE/BUG.yaml
vendored
Normal file
@@ -0,0 +1,94 @@
|
||||
name: Bug Report
|
||||
description: Create a bug report to help improve simulat.
|
||||
title: "[BUG] "
|
||||
labels:
|
||||
- bug
|
||||
- triage
|
||||
assignees:
|
||||
- 'pufereq'
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Hey! Thanks for taking the time to report a bug. Please fill out the form below to help us fix it.
|
||||
- type: checkboxes
|
||||
id: checked_existing_issues
|
||||
attributes:
|
||||
label: Have you checked the existing issues?
|
||||
description: Before submitting a new issue, please check if there is an existing issue that reports the same bug.
|
||||
options:
|
||||
- label: I have checked the existing issues.
|
||||
required: true
|
||||
- type: input
|
||||
id: bug_title
|
||||
attributes:
|
||||
label: Bug Title
|
||||
description: A clear and concise title that describes the bug.
|
||||
placeholder: "Ex. Game crashes when I open the inventory"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: current_behavior
|
||||
attributes:
|
||||
label: Current Behavior
|
||||
description: Describe what is currently happening.
|
||||
placeholder: "Ex. When I open the inventory, the game crashes."
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: expected_behavior
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
description: Describe what you expected to happen.
|
||||
placeholder: "Ex. When I open the inventory, I should see my items."
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: steps_to_reproduce
|
||||
attributes:
|
||||
label: Steps to Reproduce
|
||||
description: Provide detailed steps to reproduce the bug.
|
||||
placeholder: |
|
||||
1. Open the game
|
||||
2. Click on the inventory button
|
||||
3. Observe the crash
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: environment
|
||||
attributes:
|
||||
label: Environment
|
||||
description: Provide information about your environment.
|
||||
placeholder: |
|
||||
- OS: Windows 10
|
||||
- Python Version: 3.12.3
|
||||
- simulat Version: 0.17.1
|
||||
value: |
|
||||
- "OS: "
|
||||
- "Python Version: "
|
||||
- "simulat Version: "
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Logs
|
||||
description: If you have any logs, paste them here.
|
||||
placeholder: "Ex. Error message, stack trace, etc."
|
||||
render: shell
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: additional_information
|
||||
attributes:
|
||||
label: Additional Information
|
||||
description: |
|
||||
Add any other information that might be helpful, such as links, screenshots etc.
|
||||
|
||||
Tip: You can attach files by dragging and dropping them here.
|
||||
**Note: Please do not include any sensitive information.**
|
||||
placeholder: "Ex. I have tried restarting the game and it still crashes."
|
||||
render: markdown
|
||||
validations:
|
||||
required: false
|
||||
55
.github/ISSUE_TEMPLATE/FEAT.yaml
vendored
Normal file
55
.github/ISSUE_TEMPLATE/FEAT.yaml
vendored
Normal file
@@ -0,0 +1,55 @@
|
||||
name: Feature request
|
||||
description: Suggest an idea for this project.
|
||||
title: "[FEAT] "
|
||||
labels:
|
||||
- enhancement
|
||||
assignees:
|
||||
- 'pufereq'
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Hey! Thanks for taking the time to suggest a feature. Please fill out the form below to help us understand it better.
|
||||
- type: input
|
||||
id: feature_title
|
||||
attributes:
|
||||
label: Feature Title
|
||||
description: A clear and concise title that describes the feature.
|
||||
placeholder: "Ex. Add a new tile type: Water"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: feature_description
|
||||
attributes:
|
||||
label: Feature Description
|
||||
description: Describe the feature you are suggesting.
|
||||
placeholder: "Ex. Add a new tile type that can be placed on water."
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: feature_usage
|
||||
attributes:
|
||||
label: Feature Usage
|
||||
description: Describe how the feature should be used.
|
||||
placeholder: |
|
||||
Add a Water tile. This tile should have collision.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: feature_reason
|
||||
attributes:
|
||||
label: Feature Reason
|
||||
description: Why should this feature be added?
|
||||
placeholder: |
|
||||
Water tiles are a common feature in games and can be used to create interesting worlds.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: feature_additional_info
|
||||
attributes:
|
||||
label: Additional Information
|
||||
description: Provide any additional information that may be helpful.
|
||||
placeholder: |
|
||||
The Water tile should have a blue texture.
|
||||
validations:
|
||||
required: false
|
||||
Reference in New Issue
Block a user