Skip to content

Commit f87f55f

Browse files
committed
feat: Add pull request and issue templates
1 parent 6fac6b7 commit f87f55f

File tree

3 files changed

+108
-0
lines changed

3 files changed

+108
-0
lines changed
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Bug Report
3+
about: Report a reproducible bug
4+
title: "[Bug]: "
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
## Description
11+
<!-- A clear and concise description of the bug. -->
12+
13+
## Steps to Reproduce
14+
<!-- Provide a step-by-step guide to reproduce the issue. -->
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
## Expected Behavior
21+
<!-- A clear and concise description of what you expected to happen. -->
22+
23+
## Actual Behavior
24+
<!-- A clear and concise description of what actually happened. -->
25+
26+
## Environment
27+
<!-- Please provide details about your environment. -->
28+
- **Operating System:** [e.g., macOS 14.4.1]
29+
- **App Version:** [e.g., 1.0.0]
30+
- **Xcode Version:** [e.g., 15.3]
31+
32+
## Additional Context
33+
<!-- Add any other context about the problem here. -->
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: "[Feature]: "
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
## Description
11+
<!-- A clear and concise description of the feature you are requesting. -->
12+
13+
## Why is this feature needed?
14+
<!-- Explain the problem this feature would solve or the benefit it would provide. -->
15+
16+
## Proposed Solution (Optional)
17+
<!-- Describe how you think this feature could be implemented. -->
18+
19+
## Additional Context
20+
<!-- Add any other context or screenshots about the feature request here. -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Pull Request
2+
3+
## Description
4+
<!-- Provide a clear and concise description of the changes made in this PR -->
5+
6+
## Type of Change
7+
<!-- Mark the appropriate option with an [x] -->
8+
- [ ] New feature (non-breaking change which adds functionality)
9+
- [ ] Bug fix (non-breaking change which fixes an issue)
10+
- [ ] Performance improvement
11+
- [ ] Code refactoring (no functional changes)
12+
- [ ] Documentation update
13+
- [ ] UI/UX improvement
14+
- [ ] Build/CI pipeline changes
15+
- [ ] Other (please describe):
16+
17+
## Related Issues
18+
<!-- Link to any related issues using the format: Fixes #issue_number -->
19+
<!-- If no issues are related, you can remove this section -->
20+
21+
## Testing Performed
22+
<!-- Describe the tests you've performed to verify your changes -->
23+
<!-- Include details of your testing environment, tests ran, and results -->
24+
25+
## Screenshots
26+
<!-- For UI changes, include before/after screenshots or screen recordings -->
27+
<!-- Remove this section if not applicable -->
28+
29+
## Checklist
30+
<!-- Mark completed items with an [x] -->
31+
32+
### Development
33+
- [ ] Code follows Swift API Design Guidelines
34+
- [ ] SwiftLint has been run (`swiftlint autocorrect`)
35+
- [ ] C code follows Linux kernel coding style (if applicable)
36+
- [ ] Code is properly documented (DocC for Swift, Doxygen for C)
37+
- [ ] No new warnings or errors are introduced
38+
39+
### Testing
40+
- [ ] Added/updated unit tests (80%+ coverage for core modules)
41+
- [ ] Added/updated performance tests (for battery monitoring changes)
42+
- [ ] Added/updated UI tests (for power flow visualization changes)
43+
- [ ] All tests pass locally
44+
45+
### Documentation
46+
- [ ] Updated documentation for new/modified features
47+
- [ ] Comments added for complex code sections
48+
49+
### Review Requirements
50+
- [ ] PR requires 2 maintainer approvals
51+
- [ ] CI passes SwiftPM tests and lint checks
52+
- [ ] Security-sensitive code has been audited (if applicable)
53+
54+
## Additional Notes
55+
<!-- Add any other information about the PR here -->

0 commit comments

Comments
 (0)