Skip to content
This repository was archived by the owner on Mar 31, 2025. It is now read-only.

Commit 0be2475

Browse files
Add Github templates
1 parent 8c40fa6 commit 0be2475

File tree

3 files changed

+121
-0
lines changed

3 files changed

+121
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Bug report
2+
description: Create a report to help us improve
3+
labels: bug
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: 📖 Description
9+
description: A clear and concise description of what the bug is.
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: environment
14+
attributes:
15+
label: ℹ️ Environment
16+
description: |
17+
An environment information where issue occurred. Try to provide as much information as possible, including:
18+
- device name, model and manufacturer (e.g. Google Pixel 9)
19+
- operating system version (e.g. Android 12)
20+
- software name, version and build number (e.g The Library 4.2.1)
21+
- additional information (e.g. dependencies, IDE, etc.)
22+
value: |
23+
- Device:
24+
- Operating system:
25+
- Software information:
26+
- Additional information:
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: reproduction-steps
31+
attributes:
32+
label: 💣 Steps to reproduce
33+
description: Steps to reproduce the behavior.
34+
value: |
35+
1. Go to '...'
36+
2. Click on '....'
37+
3. Scroll down to '....'
38+
...
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: expected-behavior
43+
attributes:
44+
label: 🔧 Expected behavior
45+
description: A clear and concise description of what you expected to happen.
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: additional-information
50+
attributes:
51+
label: 📄 Additional information
52+
description: Any additional information that might be helpful in solving the issue. Including screenshots, logs, etc.
53+
validations:
54+
required: false
+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Feature request
2+
description: Propose a new feature or an idea for this project
3+
labels: enhancement
4+
body:
5+
- type: textarea
6+
id: feature-description
7+
attributes:
8+
label: 💡 Feature description
9+
description: A clear and concise description of the feature request, including what problem it solves.
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: additional-information
14+
attributes:
15+
label: ℹ️ Additional information
16+
description: An additional information or screenshots about the feature request.
17+
validations:
18+
required: false
19+
- type: textarea
20+
id: alternatives
21+
attributes:
22+
label: 🤔 Describe alternatives you've considered
23+
description: Can you think of alternative approaches to achieve same goal?
24+
validations:
25+
required: false

.github/pull_request_template.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## Summary
2+
3+
<!--
4+
Provide an overview of what this pull request aims to address or achieve.
5+
-->
6+
7+
**Related issue**: <!-- Add the issue number in format [#<number>](link) or set to "None" if this is not related to a reported issue. -->
8+
9+
## Changes
10+
11+
### Type
12+
13+
- [ ] **Feature**: This pull request introduces a new feature.
14+
- [ ] **Bug fix**: This pull request fixes a bug.
15+
- [ ] **Refactor**: This pull request refactors existing code.
16+
- [ ] **Documentation**: This pull request updates documentation.
17+
- [ ] **Other**: This pull request makes other changes.
18+
19+
#### Additional information
20+
21+
- [ ] This pull request introduces a **breaking change**.
22+
23+
### Description
24+
25+
<!--
26+
Describe the specific changes made in this pull request, including any technical details or architectural decisions.
27+
28+
If applicable, include additional information like screenshots, logs or other data that demonstrate the changes.
29+
-->
30+
31+
## Checklist
32+
33+
- [ ] I have performed a self-review of my own code.
34+
- [ ] I have tested my changes, including edge cases.
35+
- [ ] I have added necessary tests for the changes introduced (if applicable).
36+
- [ ] I have updated the documentation to reflect my changes (if applicable).
37+
38+
## Additional notes
39+
40+
<!--
41+
Add any additional comments, instructions, or insights about this pull request.
42+
-->

0 commit comments

Comments
 (0)