diff --git a/.github/PULL_REQUEST_TEMPLATE/bug_fix.md b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md new file mode 100644 index 0000000..d8892f1 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md @@ -0,0 +1,74 @@ +# ๐Ÿ› Bug Fix Pull Request + +## ๐Ÿ“ Bug Description + + +**What was the problem?** +- + +**How did it manifest?** +- + +## ๐Ÿ”ง Solution + + +**What was changed?** +- + +**Why is this the correct solution?** +- + +## ๐Ÿงช Testing + + +- [ ] 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 + + +**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) \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/documentation.md b/.github/PULL_REQUEST_TEMPLATE/documentation.md new file mode 100644 index 0000000..a867021 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/documentation.md @@ -0,0 +1,117 @@ +# ๐Ÿ“š Documentation Pull Request + +## ๐Ÿ“ Documentation Changes + + +**What is being documented/updated?** +- + +**Why is this documentation necessary?** +- + +## ๐Ÿ“‹ Type of Documentation + + +- [ ] ๐Ÿ“– README.md Update +- [ ] ๐Ÿ“˜ API Documentation +- [ ] ๐Ÿ”ง Configuration Guide +- [ ] ๐Ÿš€ Installation Instructions +- [ ] ๐ŸŽฏ Usage Examples +- [ ] ๐Ÿ› Troubleshooting Guide +- [ ] ๐Ÿ”„ Changelog +- [ ] ๐Ÿ’ก Code Comments +- [ ] ๐Ÿ—๏ธ Architecture Documentation +- [ ] ๐Ÿงช Testing Documentation +- [ ] ๐Ÿ”’ Security Documentation + +## ๐ŸŽฏ Target Audience + + +- [ ] ๐Ÿ‘จโ€๐Ÿ’ป 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 + + +**Before:** + + +**After:** + + +## ๐Ÿงช 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 + + +- [ ] 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) \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/feature.md b/.github/PULL_REQUEST_TEMPLATE/feature.md new file mode 100644 index 0000000..0b10c1a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/feature.md @@ -0,0 +1,117 @@ +# โœจ Feature Pull Request + +## ๐Ÿ“ Feature Description + + +**What is being added?** +- + +**Why is this feature useful?** +- + +**Who benefits from it?** +- + +## ๐ŸŽฏ Goals + + +- [ ] +- [ ] +- [ ] + +## ๐Ÿ”ง Implementation Details + + +**New functions:** +- + +**Changed functions:** +- + +**API changes:** +- + +## ๐Ÿงช Testing Strategy + + +- [ ] Unit tests created +- [ ] Integration tests created +- [ ] Manual testing performed +- [ ] Performance tests (if relevant) +- [ ] Hardware testing (AIO cooler) +- [ ] Edge cases tested + +**Test Scenarios:** +1. +2. +3. + +## ๐Ÿ“‹ 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 + + +## ๐Ÿš€ Performance Impact + + +**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 + + +- [ ] 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) \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..c270a88 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,77 @@ +# Pull Request + +## ๐ŸŽฏ Specialized Templates Available + + +- ๐Ÿ› **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 + + +## ๐Ÿ”„ Type of Change + + +- [ ] ๐Ÿ› 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? + + +- [ ] Unit Tests +- [ ] Integration Tests +- [ ] Manual Testing +- [ ] Tested on target hardware (AIO cooler) + +**Test Configuration:** +- Compiler version: +- OS: +- Hardware: + +## ๐Ÿ“‹ Checklist + + +- [ ] 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 + + +Fixes #(issue number) +Closes #(issue number) +Related to #(issue number) + +## ๐Ÿ“ธ Screenshots (if UI changes) + + +## ๐Ÿ“š Additional Notes + + +## ๐ŸŽฏ Codacy Analysis + + +- [ ] Codacy analysis without new issues +- [ ] All found issues have been fixed + +--- + +**For Maintainers:** +- [ ] Code review performed +- [ ] Tests pass +- [ ] Documentation updated +- [ ] Ready to merge \ No newline at end of file