Skip to content

Commit cbc08b8

Browse files
blink-zeroblink-zero
committed
Add GitHub templates for issues and pull requests
1 parent 2c74acb commit cbc08b8

File tree

5 files changed

+142
-0
lines changed

5 files changed

+142
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve PowerPulse
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
A clear and concise description of what the bug is.
11+
12+
## Steps To Reproduce
13+
Steps to reproduce the behavior:
14+
1. Go to '...'
15+
2. Click on '....'
16+
3. Scroll down to '....'
17+
4. See error
18+
19+
## Expected Behavior
20+
A clear and concise description of what you expected to happen.
21+
22+
## Actual Behavior
23+
A clear and concise description of what actually happened.
24+
25+
## Screenshots
26+
If applicable, add screenshots to help explain your problem.
27+
28+
## Environment
29+
- PowerPulse Version: [e.g. 1.10.0]
30+
- Installation Method: [e.g. Docker, Node.js]
31+
- OS: [e.g. Ubuntu 22.04, Windows 11]
32+
- Browser: [e.g. Chrome 120, Firefox 115]
33+
- NUT Server Version: [e.g. 2.8.0]
34+
35+
## Additional Context
36+
Add any other context about the problem here. Include any relevant logs from:
37+
- Browser console
38+
- Server logs (`docker logs powerpulse-server` or server console output)
39+
- Client logs (`docker logs powerpulse-client` or client console output)

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: PowerPulse Discussions
4+
url: https://github.com/blink-zero/powerpulse/discussions
5+
about: Please ask and answer questions here.
6+
- name: PowerPulse Security Issues
7+
url: https://github.com/blink-zero/powerpulse/security/policy
8+
about: Please report security vulnerabilities here.

‎.github/ISSUE_TEMPLATE/documentation_improvement.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Documentation improvement
3+
about: Suggest improvements to PowerPulse documentation
4+
title: '[DOCS] '
5+
labels: documentation
6+
assignees: ''
7+
---
8+
9+
## Documentation Issue
10+
Describe what's missing, unclear, or incorrect in the current documentation.
11+
12+
## Affected Documentation
13+
Specify which documentation file(s) or section(s) need improvement:
14+
- [ ] README.md
15+
- [ ] API.md
16+
- [ ] DOCKER.md
17+
- [ ] KIOSK.md
18+
- [ ] CHANGELOG.md
19+
- [ ] Code comments
20+
- [ ] Other (please specify)
21+
22+
## Suggested Improvement
23+
Describe your proposed changes or additions to the documentation.
24+
25+
## Why This Matters
26+
Explain why this documentation improvement is important.
27+
28+
## Additional Context
29+
Add any other context, screenshots, or examples about the documentation improvement here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for PowerPulse
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Problem Statement
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
## Proposed Solution
13+
A clear and concise description of what you want to happen.
14+
15+
## Alternative Solutions
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
## User Benefits
19+
Explain how this feature would benefit users of PowerPulse.
20+
21+
## Implementation Ideas (Optional)
22+
If you have ideas about how to implement this feature, please share them here.
23+
24+
## Additional Context
25+
Add any other context, screenshots, or mockups about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## Description
2+
<!-- Provide a brief summary of the changes in this pull request -->
3+
4+
## Related Issue
5+
<!-- Reference any related issues using the format: Fixes #123, Resolves #456 -->
6+
7+
## Type of Change
8+
<!-- Mark the appropriate option with an "x" -->
9+
- [ ] Bug fix (non-breaking change which fixes an issue)
10+
- [ ] New feature (non-breaking change which adds functionality)
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] Documentation update
13+
- [ ] Code refactoring
14+
- [ ] Performance improvement
15+
- [ ] Test addition or update
16+
- [ ] Other (please describe):
17+
18+
## How Has This Been Tested?
19+
<!-- Describe the tests you ran to verify your changes -->
20+
- [ ] Unit tests
21+
- [ ] Integration tests
22+
- [ ] Manual testing
23+
- [ ] Other (please describe):
24+
25+
## Screenshots (if applicable)
26+
<!-- Add screenshots to help explain your changes -->
27+
28+
## Checklist
29+
<!-- Mark the appropriate options with an "x" -->
30+
- [ ] My code follows the style guidelines of this project
31+
- [ ] I have performed a self-review of my own code
32+
- [ ] I have commented my code, particularly in hard-to-understand areas
33+
- [ ] I have made corresponding changes to the documentation
34+
- [ ] My changes generate no new warnings
35+
- [ ] I have added tests that prove my fix is effective or that my feature works
36+
- [ ] New and existing unit tests pass locally with my changes
37+
- [ ] Any dependent changes have been merged and published in downstream modules
38+
- [ ] I have updated the CHANGELOG.md file with details of my changes
39+
40+
## Additional Notes
41+
<!-- Add any other information about the PR here -->

0 commit comments

Comments
 (0)