Skip to content

Commit ea854df

Browse files
committed
chore(templates): add issue and PR templates for bugs, features and pull requests
- Added bug report template with clear structure and title guidelines - Added feature request template with motivation, alternatives and context - Prepared for better triage and consistency in user contributions
2 parents 664205b + 39f5a0e commit ea854df

4 files changed

Lines changed: 163 additions & 0 deletions

File tree

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
name: 🐛 Bug Report
2+
description: Report a reproducible issue with the game or platform
3+
title: "[BUG] Component - What happens - When it happens"
4+
labels: [bug]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for reporting a bug! Please fill out the details below as clearly as possible.
10+
11+
- type: input
12+
id: environment
13+
attributes:
14+
label: 📋 Environment
15+
description: OS, browser, Unity version, etc.
16+
placeholder: "Windows 10, Unity 2022.3.5f1, Chrome 115..."
17+
18+
- type: textarea
19+
id: description
20+
attributes:
21+
label: 📝 Description
22+
description: Clearly describe the issue or requested feature.
23+
placeholder: |
24+
If it's a bug, explain what is not working.
25+
If it's a feature request, describe what you would like to see implemented.
26+
27+
- type: textarea
28+
id: screenshots
29+
attributes:
30+
label: 📸 Screenshots (if applicable)
31+
description: Add screenshots to help illustrate the issue or feature request. Use annotations if needed.
32+
placeholder: |
33+
You can drag and drop images into this field.
34+
35+
- type: textarea
36+
id: steps
37+
attributes:
38+
label: 📌 Steps to Reproduce (if bug)
39+
description: Provide detailed steps to reproduce the issue. Be as precise as possible.
40+
placeholder: |
41+
1. Step 1: ...
42+
2. Step 2: ...
43+
3. Step 3: ...
44+
45+
- type: textarea
46+
id: expected
47+
attributes:
48+
label: ✅ Expected Behaviour
49+
description: Describe what you expected to happen.
50+
placeholder: Explain the intended/normal behaviour.
51+
52+
- type: textarea
53+
id: observed
54+
attributes:
55+
label: ❌ Observed Behaviour
56+
description: Describe what is actually happening and how it differs from the expected result.
57+
placeholder: What's going wrong?
58+
59+
- type: textarea
60+
id: solution
61+
attributes:
62+
label: 💡 Possible Solution (optional)
63+
description: If you have any suggestions for the cause or fix, include them here.
64+
placeholder: Any idea what could be causing this? Suggest a fix if you have one.
65+
66+
- type: input
67+
id: projectVersion
68+
attributes:
69+
label: 📦 Project Version
70+
placeholder: "v1.2.3"
71+
72+
- type: input
73+
id: unityVersion
74+
attributes:
75+
label: 🎮 Unity Version
76+
placeholder: "2022.3.5f1"

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
blank_issues_enabled: false
2+
contact_links: []

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: ✨ Feature Request
2+
description: Suggest an idea or improvement for the project
3+
title: "[FEATURE] Component - What should be added - Why or when"
4+
labels: [enhancement]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for suggesting a new feature! Please take a moment to provide detailed information below.
10+
11+
- type: input
12+
id: environment
13+
attributes:
14+
label: 📋 Environment (optional)
15+
description: If this feature is platform-specific, mention it here (OS, Unity version, etc.)
16+
placeholder: "Windows 10, Unity 2022.3.5f1"
17+
18+
- type: textarea
19+
id: description
20+
attributes:
21+
label: 📝 Feature Description
22+
description: What would you like to see added or changed?
23+
placeholder: Describe the idea clearly, including context and intended usage.
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: motivation
29+
attributes:
30+
label: 🚀 Motivation and Rationale
31+
description: Why is this feature important or useful? What problem does it solve?
32+
placeholder: Explain the value or purpose of the feature.
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: solution
38+
attributes:
39+
label: 💡 Suggested Solution (optional)
40+
description: If you have a specific implementation idea, describe it here.
41+
placeholder: Describe how you imagine this could be implemented.
42+
43+
- type: textarea
44+
id: alternatives
45+
attributes:
46+
label: 🔄 Alternatives or workarounds
47+
description: Have you considered other ways to achieve the same result?
48+
placeholder: Mention any existing solutions or compromises you've tried.
49+
50+
- type: textarea
51+
id: additional
52+
attributes:
53+
label: 📎 Additional Context or References
54+
description: Add any relevant links, sketches, screenshots, or examples.
55+
placeholder: Include images, similar feature references, or design notes if relevant.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
### Description
2+
Please provide a brief summary of the changes and the purpose of this pull request.
3+
4+
### Related Issue(s)
5+
Please list any related issue(s) or feature request(s) that are addressed by this pull request. Use the following format: "Fixes #IssueNumber".
6+
7+
### Changes Made
8+
Please describe the changes made in this pull request. Include relevant details such as new features, bug fixes, or improvements.
9+
10+
### Testing
11+
Outline the testing steps taken to verify the changes made in this pull request. Include information on any automated tests or manual testing performed.
12+
13+
### Screenshots (if applicable)
14+
If your changes include visual modifications or new UI elements, please provide screenshots or GIFs demonstrating the changes.
15+
16+
### Checklist
17+
- [ ] I have tested these changes thoroughly.
18+
- [ ] The code follows the project's style guide and coding conventions.
19+
- [ ] I have updated the relevant documentation (if applicable).
20+
- [ ] All tests passed successfully.
21+
- [ ] I have checked for any potential conflicts with other branches.
22+
23+
### Additional Notes (if any)
24+
Add any additional notes, concerns, or information that may be helpful for reviewers.
25+
26+
### Reviewer(s) (optional)
27+
If you have any specific individuals in mind to review this pull request, you can mention them here.
28+
29+
### Definition of Done
30+
Specify the criteria that need to be met for this pull request to be considered complete and ready for merging.

0 commit comments

Comments
 (0)