diff --git a/.github/PULL_REQUEST_TEMPLATE/bug_fix.md b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md new file mode 100644 index 0000000..b6f73c8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md @@ -0,0 +1,31 @@ +--- +name: "Bug Fix" +about: "Fix a bug with clear reproduction, scope, and tests" +title: "[BUG FIX] " +labels: ["bug"] + +--- + +## Summary +- What bug is fixed and what parts of the codebase are impacted? + +## Root Cause +- Briefly describe the underlying issue. + +## Changes +- Highlight the notable code-level modifications. + +## Reproduction +- Provide steps or a minimal snippet that reproduces the original bug. + +## Tests +- List the tests you added or ran and their results. + +## Compatibility +- Note any migration concerns or backwards compatibility considerations. + +## Checklist +- [ ] Linked issue provided +- [ ] Adds or updates tests +- [ ] Updates docs if needed +- [ ] No perf regressions diff --git a/.github/PULL_REQUEST_TEMPLATE/feature_support.md b/.github/PULL_REQUEST_TEMPLATE/feature_support.md new file mode 100644 index 0000000..9c9b888 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/feature_support.md @@ -0,0 +1,32 @@ +--- +name: "Feature Support" +about: "Add a new feature with clear scope and tests" +title: "[FEATURE] " +labels: ["feature"] + +--- + +## Summary +- What feature is being added and why? + +## Design +- Outline the design or architecture and mention alternatives considered. + +## Changes +- Describe new or changed public APIs, configuration, or CLI behaviour. + +## Implementation Notes +- Highlight tricky parts or noteworthy implementation details. + +## Tests +- List unit or integration tests you added or updated and how you validated them. + +## Documentation +- Mention doc updates or examples that accompany this feature. + +## Checklist +- [ ] Linked issue provided +- [ ] API stabilized +- [ ] Tests added or updated +- [ ] Docs added or updated +- [ ] No known performance regressions diff --git a/.github/PULL_REQUEST_TEMPLATE/performance_optimization.md b/.github/PULL_REQUEST_TEMPLATE/performance_optimization.md new file mode 100644 index 0000000..cd022c2 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/performance_optimization.md @@ -0,0 +1,31 @@ +--- +name: "Performance Optimization" +about: "Optimize performance with benchmark evidence" +title: "[PERFORMANCE OPTIMIZATION] " +labels: ["performance"] + +--- + +## Summary +- What is optimized and why? + +## Baseline metrics +- Provide the current performance numbers and environment. + +## Approach +- Describe the optimization techniques used. + +## Results +- Share before/after benchmarks and how to reproduce them. + +## Impact +- Note memory, throughput trade-offs, or hardware-specific considerations. + +## Risks +- Highlight edge cases, correctness risks, or gating tests added. + +## Checklist +- [ ] Linked issue provided +- [ ] Benchmarks included and reproducible +- [ ] No accuracy regression +- [ ] Docs updated where needed