Skip to content

Commit 7895ffd

Browse files
authored
Merge pull request #51 from flash-algo/add-template
Add-template
2 parents a46ab86 + 7388f44 commit 7895ffd

File tree

3 files changed

+94
-0
lines changed

3 files changed

+94
-0
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: "Bug Fix"
3+
about: "Fix a bug with clear reproduction, scope, and tests"
4+
title: "[BUG FIX] "
5+
labels: ["bug"]
6+
7+
---
8+
9+
## Summary
10+
- What bug is fixed and what parts of the codebase are impacted?
11+
12+
## Root Cause
13+
- Briefly describe the underlying issue.
14+
15+
## Changes
16+
- Highlight the notable code-level modifications.
17+
18+
## Reproduction
19+
- Provide steps or a minimal snippet that reproduces the original bug.
20+
21+
## Tests
22+
- List the tests you added or ran and their results.
23+
24+
## Compatibility
25+
- Note any migration concerns or backwards compatibility considerations.
26+
27+
## Checklist
28+
- [ ] Linked issue provided
29+
- [ ] Adds or updates tests
30+
- [ ] Updates docs if needed
31+
- [ ] No perf regressions
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: "Feature Support"
3+
about: "Add a new feature with clear scope and tests"
4+
title: "[FEATURE] "
5+
labels: ["feature"]
6+
7+
---
8+
9+
## Summary
10+
- What feature is being added and why?
11+
12+
## Design
13+
- Outline the design or architecture and mention alternatives considered.
14+
15+
## Changes
16+
- Describe new or changed public APIs, configuration, or CLI behaviour.
17+
18+
## Implementation Notes
19+
- Highlight tricky parts or noteworthy implementation details.
20+
21+
## Tests
22+
- List unit or integration tests you added or updated and how you validated them.
23+
24+
## Documentation
25+
- Mention doc updates or examples that accompany this feature.
26+
27+
## Checklist
28+
- [ ] Linked issue provided
29+
- [ ] API stabilized
30+
- [ ] Tests added or updated
31+
- [ ] Docs added or updated
32+
- [ ] No known performance regressions
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: "Performance Optimization"
3+
about: "Optimize performance with benchmark evidence"
4+
title: "[PERFORMANCE OPTIMIZATION] "
5+
labels: ["performance"]
6+
7+
---
8+
9+
## Summary
10+
- What is optimized and why?
11+
12+
## Baseline metrics
13+
- Provide the current performance numbers and environment.
14+
15+
## Approach
16+
- Describe the optimization techniques used.
17+
18+
## Results
19+
- Share before/after benchmarks and how to reproduce them.
20+
21+
## Impact
22+
- Note memory, throughput trade-offs, or hardware-specific considerations.
23+
24+
## Risks
25+
- Highlight edge cases, correctness risks, or gating tests added.
26+
27+
## Checklist
28+
- [ ] Linked issue provided
29+
- [ ] Benchmarks included and reproducible
30+
- [ ] No accuracy regression
31+
- [ ] Docs updated where needed

0 commit comments

Comments
 (0)