Skip to content

Commit e645ffe

Browse files
docs(issue-templates): add bug report and feature request templates to enhance issue tracking
1 parent 54dc257 commit e645ffe

File tree

3 files changed

+77
-20
lines changed

3 files changed

+77
-20
lines changed
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: "Bug report"
3+
description: "Report a reproducible bug or regression."
4+
labels: [bug]
5+
---
6+
7+
## Describe the bug
8+
9+
A clear and concise description of what the bug is.
10+
11+
## To Reproduce
12+
13+
Steps to reproduce the behavior:
14+
15+
1. Go to '...'
16+
2. Run '...'
17+
3. See error
18+
19+
## Expected behavior
20+
21+
A clear and concise description of what you expected to happen.
22+
23+
## Actual behavior
24+
25+
What actually happened instead?
26+
27+
## Environment (please complete the following information):
28+
29+
- OS: [e.g. iOS, Android]
30+
- Dart/Flutter version: [e.g. 3.0.0, 2.10.0]
31+
- Library version: [e.g. 1.2.3]
32+
33+
## Additional context
34+
35+
Add any other context about the problem here. Include logs, error messages, or screenshots if possible.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: "Feature request"
3+
description: "Suggest an idea or enhancement for this project."
4+
labels: [enhancement]
5+
---
6+
7+
## Is your feature request related to a problem? Please describe.
8+
9+
A clear and concise description of what the problem is. Ex: I'm always frustrated when [...]
10+
11+
## Describe the solution you'd like
12+
13+
A clear and concise description of what you want to happen.
14+
15+
## Describe alternatives you've considered
16+
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
## Additional context
20+
21+
Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,34 @@
1-
# Pull Request Template
1+
# Pull Request
22

3-
## Summary
3+
## Description
44

5-
<!-- Provide a concise description of your changes. What does this PR do? -->
5+
Please include a summary of the change and which issue is fixed. Also include relevant motivation and context.
66

7-
## Motivation & Context
7+
Fixes # (issue)
88

9-
<!-- Why is this change necessary? What problem does it solve? Reference any related issues. -->
9+
## Type of change
1010

11-
## Related Issues
12-
13-
<!-- List any related issues, e.g., Fixes #123 or Closes #456. -->
14-
15-
## Implementation Details
16-
17-
<!-- Briefly describe your approach, design decisions, and any patterns or principles followed. -->
11+
- [ ] Bug fix
12+
- [ ] New feature
13+
- [ ] Breaking change
14+
- [ ] Documentation update
15+
- [ ] Other (please describe):
1816

1917
## How Has This Been Tested?
2018

21-
<!-- Describe the testing strategy. List manual steps, automated tests, and edge cases considered. -->
19+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
2220

2321
## Checklist
2422

25-
- [ ] My code follows the project's code style and conventions
26-
- [ ] I have added/updated relevant documentation
27-
- [ ] I have added/updated tests to cover my changes
28-
- [ ] All existing and new tests pass locally
29-
- [ ] I have considered security and data validation aspects
23+
- [ ] My code follows the style guidelines of this project
24+
- [ ] I have performed a self-review of my own code
25+
- [ ] I have commented my code, particularly in hard-to-understand areas
26+
- [ ] I have made corresponding changes to the documentation
27+
- [ ] My changes generate no new warnings
28+
- [ ] I have added tests that prove my fix is effective or that my feature works
29+
- [ ] New and existing unit tests pass locally with my changes
30+
- [ ] Any dependent changes have been merged and published in downstream modules
3031

31-
## Notes for Reviewers
32+
## Additional context
3233

33-
<!-- Add any extra context, open questions, or areas where you'd like feedback. -->
34+
Add any other context or screenshots about the pull request here.

0 commit comments

Comments
 (0)