-
-
Notifications
You must be signed in to change notification settings - Fork 0
add: PULL_REQUEST_TEMPLATEs for bugs, features, and documentation. #39
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| # 🐛 Bug Fix Pull Request | ||
|
|
||
| ## 📝 Bug Description | ||
| <!-- Describe the bug that is being fixed --> | ||
|
|
||
| **What was the problem?** | ||
| - | ||
|
|
||
| **How did it manifest?** | ||
| - | ||
|
|
||
| ## 🔧 Solution | ||
| <!-- Describe your solution --> | ||
|
|
||
| **What was changed?** | ||
| - | ||
|
|
||
| **Why is this the correct solution?** | ||
| - | ||
|
|
||
| ## 🧪 Testing | ||
| <!-- Describe how you tested the fix --> | ||
|
|
||
| - [ ] Bug reproduced (before fix) | ||
| - [ ] Fix implemented | ||
| - [ ] Bug no longer reproducible (after fix) | ||
| - [ ] Regression tests performed | ||
| - [ ] Unit tests added/updated | ||
|
|
||
| **Test Environment:** | ||
| - Compiler: | ||
| - OS: | ||
| - Hardware: | ||
|
|
||
| ## 📋 Bug Fix Checklist | ||
|
|
||
| - [ ] Root cause identified | ||
| - [ ] Minimal change implemented | ||
| - [ ] No side effects introduced | ||
| - [ ] Error handling improved (if relevant) | ||
| - [ ] Logging added (if relevant) | ||
| - [ ] Code review requested | ||
| - [ ] Documentation updated (if needed) | ||
|
|
||
| ## 🔗 Related Issues | ||
|
|
||
| Fixes #(issue number) | ||
|
|
||
| ## 📊 Before/After | ||
| <!-- Screenshots or logs before and after the fix --> | ||
|
|
||
| **Before:** | ||
| ``` | ||
| // Error logs or screenshots | ||
| ``` | ||
|
|
||
| **After:** | ||
| ``` | ||
| // Fixed behavior or screenshots | ||
| ``` | ||
|
|
||
| ## 🎯 Codacy Analysis | ||
|
|
||
| - [ ] Codacy analysis without new issues | ||
| - [ ] All security issues fixed | ||
| - [ ] Code quality improved | ||
|
|
||
| --- | ||
|
|
||
| **Priority:** | ||
| - [ ] 🔴 Critical (Production down) | ||
| - [ ] 🟠 High (Major feature broken) | ||
| - [ ] 🟡 Medium (Minor feature issue) | ||
| - [ ] 🟢 Low (Cosmetic issue) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| # 📚 Documentation Pull Request | ||
Check noticeCode scanning / Remark-lint (reported by Codacy) Warn when a line feed at the end of a file is missing. Note documentation
[final-newline] Missing newline character at end of file
|
||
|
|
||
| ## 📝 Documentation Changes | ||
| <!-- Describe what documentation is being changed --> | ||
|
|
||
| **What is being documented/updated?** | ||
| - | ||
|
|
||
| **Why is this documentation necessary?** | ||
| - | ||
|
|
||
| ## 📋 Type of Documentation | ||
| <!-- Mark the applicable documentation types --> | ||
|
|
||
| - [ ] 📖 README.md Update | ||
| - [ ] 📘 API Documentation | ||
| - [ ] 🔧 Configuration Guide | ||
| - [ ] 🚀 Installation Instructions | ||
| - [ ] 🎯 Usage Examples | ||
| - [ ] 🐛 Troubleshooting Guide | ||
| - [ ] 🔄 Changelog | ||
| - [ ] 💡 Code Comments | ||
| - [ ] 🏗️ Architecture Documentation | ||
| - [ ] 🧪 Testing Documentation | ||
| - [ ] 🔒 Security Documentation | ||
|
|
||
| ## 🎯 Target Audience | ||
| <!-- Who is the target audience for this documentation? --> | ||
|
|
||
| - [ ] 👨💻 Developers | ||
| - [ ] 👤 End Users | ||
| - [ ] 🔧 System Administrators | ||
| - [ ] 🚀 Contributors | ||
| - [ ] 🏢 Project Maintainers | ||
|
|
||
| ## 📋 Documentation Checklist | ||
|
|
||
| ### Content Quality | ||
| - [ ] Information is correct and up-to-date | ||
| - [ ] Clear and understandable language | ||
| - [ ] Logical structure and organization | ||
| - [ ] Complete information (no important details missing) | ||
| - [ ] Consistent with existing documentation | ||
|
|
||
| ### Technical Accuracy | ||
| - [ ] Code examples are functional | ||
| - [ ] Commands have been tested | ||
| - [ ] Links work correctly | ||
| - [ ] Screenshots are current (if present) | ||
| - [ ] Version numbers are correct | ||
|
|
||
| ### Format & Style | ||
| - [ ] Markdown syntax correct | ||
| - [ ] Consistent formatting | ||
| - [ ] Correct spelling and grammar | ||
| - [ ] Appropriate use of headers | ||
| - [ ] Code blocks properly formatted | ||
|
|
||
| ## 🔗 Related Issues | ||
|
|
||
| Addresses #(issue number) | ||
| Closes #(issue number) | ||
|
|
||
| ## 📸 Before/After | ||
| <!-- Screenshots of documentation before and after changes --> | ||
|
|
||
| **Before:** | ||
| <!-- Previous state of documentation --> | ||
|
|
||
| **After:** | ||
| <!-- New state of documentation --> | ||
|
|
||
| ## 🧪 Documentation Testing | ||
|
|
||
| - [ ] All code examples tested | ||
| - [ ] Installation instructions verified | ||
| - [ ] Links checked | ||
| - [ ] Screenshots updated | ||
| - [ ] Cross-platform compatibility checked | ||
|
|
||
| ## 💬 Review Guidelines | ||
|
|
||
| **For Reviewers:** | ||
| - [ ] Content accuracy checked | ||
| - [ ] Clarity and comprehensibility assessed | ||
| - [ ] Completeness verified | ||
| - [ ] Format and style checked | ||
| - [ ] Links and code examples tested | ||
|
|
||
| ## 🌍 Localization | ||
| <!-- If relevant for multilingual documentation --> | ||
|
|
||
| - [ ] English documentation | ||
| - [ ] German documentation (if relevant) | ||
| - [ ] Terminology consistent | ||
|
|
||
| ## 📊 Impact Assessment | ||
|
|
||
| **What does this documentation improve?** | ||
| - | ||
|
|
||
| **What problems does it solve?** | ||
| - | ||
|
|
||
| **Expected impact:** | ||
| - [ ] Reduced support requests | ||
| - [ ] Improved user experience | ||
| - [ ] Easier onboarding for new users | ||
| - [ ] Better developer experience | ||
|
|
||
| --- | ||
|
|
||
| **Documentation Priority:** | ||
| - [ ] 🔴 Critical (Missing essential docs) | ||
| - [ ] 🟠 High (Important user-facing docs) | ||
| - [ ] 🟡 Medium (Helpful additions) | ||
| - [ ] 🟢 Low (Nice-to-have improvements) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| # ✨ Feature Pull Request | ||
Check noticeCode scanning / Remark-lint (reported by Codacy) Warn when a line feed at the end of a file is missing. Note
[final-newline] Missing newline character at end of file
|
||
|
|
||
| ## 📝 Feature Description | ||
| <!-- Describe the new feature --> | ||
|
|
||
| **What is being added?** | ||
| - | ||
|
|
||
| **Why is this feature useful?** | ||
| - | ||
|
|
||
| **Who benefits from it?** | ||
| - | ||
|
|
||
| ## 🎯 Goals | ||
| <!-- Define clear goals for this feature --> | ||
|
|
||
| - [ ] | ||
| - [ ] | ||
| - [ ] | ||
|
|
||
| ## 🔧 Implementation Details | ||
| <!-- Technical details of the implementation --> | ||
|
|
||
| **New functions:** | ||
| - | ||
|
|
||
| **Changed functions:** | ||
| - | ||
|
|
||
| **API changes:** | ||
| - | ||
|
|
||
| ## 🧪 Testing Strategy | ||
| <!-- How was the feature tested? --> | ||
|
|
||
| - [ ] Unit tests created | ||
| - [ ] Integration tests created | ||
| - [ ] Manual testing performed | ||
| - [ ] Performance tests (if relevant) | ||
| - [ ] Hardware testing (AIO cooler) | ||
| - [ ] Edge cases tested | ||
|
|
||
| **Test Scenarios:** | ||
| 1. | ||
Check noticeCode scanning / Remark-lint (reported by Codacy) Warn when the list item marker style of ordered lists violate a given style. Note
[ordered-list-marker-style] Marker style should be .
|
||
| 2. | ||
Check noticeCode scanning / Remark-lint (reported by Codacy) Warn when the list item marker style of ordered lists violate a given style. Note
[ordered-list-marker-style] Marker style should be .
Check noticeCode scanning / Remark-lint (reported by Codacy) Warn when the list item marker values of ordered lists violate a given Note
[ordered-list-marker-value] Marker should be 2, was 0
|
||
| 3. | ||
Check noticeCode scanning / Remark-lint (reported by Codacy) Warn when the list item marker values of ordered lists violate a given Note
[ordered-list-marker-value] Marker should be 3, was 0
Check noticeCode scanning / Remark-lint (reported by Codacy) Warn when the list item marker style of ordered lists violate a given style. Note
[ordered-list-marker-style] Marker style should be .
|
||
|
|
||
| ## 📋 Feature Checklist | ||
|
|
||
| - [ ] Feature requirement met | ||
| - [ ] Code style guidelines followed | ||
| - [ ] Error handling implemented | ||
| - [ ] Input validation added | ||
| - [ ] Logging implemented | ||
| - [ ] Performance optimized | ||
| - [ ] Memory management correct | ||
| - [ ] Thread safety considered (if relevant) | ||
| - [ ] Backward compatibility ensured | ||
| - [ ] Configuration options added (if needed) | ||
|
|
||
| ## 📚 Documentation | ||
|
|
||
| - [ ] Code comments added | ||
| - [ ] README.md updated | ||
| - [ ] API documentation created/updated | ||
| - [ ] Configuration documentation updated | ||
| - [ ] Changelog updated | ||
|
|
||
| ## 🔗 Related Issues | ||
|
|
||
| Implements #(issue number) | ||
| Related to #(issue number) | ||
|
|
||
| ## 📸 Screenshots/Demo | ||
| <!-- Show the new feature in action --> | ||
|
|
||
| ## 🚀 Performance Impact | ||
| <!-- Analysis of performance implications --> | ||
|
|
||
| **Memory Usage:** | ||
| - Before: | ||
| - After: | ||
|
|
||
| **CPU Usage:** | ||
| - Before: | ||
| - After: | ||
|
|
||
| **Benchmarks:** | ||
| - | ||
|
|
||
| ## 🎯 Codacy Analysis | ||
|
|
||
| - [ ] Codacy analysis passed | ||
| - [ ] No new security issues | ||
| - [ ] Code complexity acceptable | ||
| - [ ] Test coverage sufficient | ||
|
|
||
| ## 🔄 Breaking Changes | ||
| <!-- Are there any breaking changes? --> | ||
|
|
||
| - [ ] No breaking changes | ||
| - [ ] Breaking changes (list below): | ||
|
|
||
| **Breaking Changes:** | ||
| - | ||
|
|
||
| **Migration Guide:** | ||
| - | ||
|
|
||
| --- | ||
|
|
||
| **Feature Size:** | ||
| - [ ] 🟢 Small (< 100 lines) | ||
| - [ ] 🟡 Medium (100-500 lines) | ||
| - [ ] 🟠 Large (500-1000 lines) | ||
| - [ ] 🔴 Extra Large (> 1000 lines) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| # Pull Request | ||
Check noticeCode scanning / Remark-lint (reported by Codacy) Warn when a line feed at the end of a file is missing. Note
[final-newline] Missing newline character at end of file
|
||
|
|
||
| ## 🎯 Specialized Templates Available | ||
| <!-- For specific PR types, use the corresponding templates: --> | ||
|
|
||
| - 🐛 **Bug Fix**: [Use bug_fix.md template](?template=bug_fix.md) | ||
| - ✨ **New Feature**: [Use feature.md template](?template=feature.md) | ||
| - 📚 **Documentation**: [Use documentation.md template](?template=documentation.md) | ||
|
|
||
| --- | ||
|
|
||
| ## 📝 Description | ||
| <!-- Briefly describe what this PR changes --> | ||
|
|
||
| ## 🔄 Type of Change | ||
| <!-- Mark the applicable options with [x] --> | ||
|
|
||
| - [ ] 🐛 Bug fix (non-breaking change that fixes an issue) | ||
| - [ ] ✨ New feature (non-breaking change that adds functionality) | ||
| - [ ] 💥 Breaking change (fix or feature that changes existing functionality) | ||
| - [ ] 📚 Documentation update (documentation) | ||
| - [ ] 🎨 Code style/formatting (no functional changes) | ||
| - [ ] ♻️ Refactoring (code change without fix/feature) | ||
| - [ ] ⚡ Performance improvement | ||
| - [ ] 🧪 Test update | ||
|
|
||
| ## 🧪 How Has This Been Tested? | ||
| <!-- Describe the tests you performed --> | ||
|
|
||
| - [ ] Unit Tests | ||
| - [ ] Integration Tests | ||
| - [ ] Manual Testing | ||
| - [ ] Tested on target hardware (AIO cooler) | ||
|
|
||
| **Test Configuration:** | ||
| - Compiler version: | ||
| - OS: | ||
| - Hardware: | ||
|
|
||
| ## 📋 Checklist | ||
| <!-- Mark completed items with [x] --> | ||
|
|
||
| - [ ] Code follows project style guidelines | ||
| - [ ] Self-review of code performed | ||
| - [ ] Code is commented, especially in hard-to-understand areas | ||
| - [ ] Corresponding documentation has been updated | ||
| - [ ] Changes generate no new warnings | ||
| - [ ] Unit tests have been added/updated | ||
| - [ ] New and existing tests pass locally | ||
| - [ ] Dependent changes have been merged and published | ||
|
|
||
| ## 🔗 Related Issues | ||
| <!-- Link relevant issues --> | ||
|
|
||
| Fixes #(issue number) | ||
| Closes #(issue number) | ||
| Related to #(issue number) | ||
|
|
||
| ## 📸 Screenshots (if UI changes) | ||
| <!-- Add screenshots if visual changes are present --> | ||
|
|
||
| ## 📚 Additional Notes | ||
| <!-- Additional information for reviewers --> | ||
|
|
||
| ## 🎯 Codacy Analysis | ||
| <!-- After creating the PR: Insert Codacy analysis results here --> | ||
|
|
||
| - [ ] Codacy analysis without new issues | ||
| - [ ] All found issues have been fixed | ||
|
|
||
| --- | ||
|
|
||
| **For Maintainers:** | ||
| - [ ] Code review performed | ||
| - [ ] Tests pass | ||
| - [ ] Documentation updated | ||
| - [ ] Ready to merge | ||
Check notice
Code scanning / Remark-lint (reported by Codacy)
Warn when a line feed at the end of a file is missing. Note