Skip to content

Commit 00c83fc

Browse files
LoserCheemsLoserCheems
authored
Merge pull request #158 from SmallDoges/update-docs
Update issue templates and add auto-assignment for PRs
2 parents bd9476e + 1fbe690 commit 00c83fc

File tree

9 files changed

+174
-103
lines changed

9 files changed

+174
-103
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
11
---
22
name: Bug report
33
about: Create a report to help us improve Flash-DMA
4-
title: '[BUG] '
5-
labels: 'bug'
6-
assignees: ''
4+
title: '[BUG REPORT] '
5+
labels: ["bug"]
6+
assignees:
7+
- LoserCheems
8+
- Evanwu1125
9+
- SNHuan
10+
- Thanksyy
11+
- ftgreat
12+
- zacliu2023
13+
- juliohsu
14+
- wubingheng111
715

816
---
917

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
11
---
22
name: Feature request
33
about: Suggest an idea for Flash-DMA
4-
title: '[FEATURE] '
5-
labels: 'enhancement'
6-
assignees: ''
4+
title: '[FEATURE REQUEST] '
5+
labels: ["feature"]
6+
assignees:
7+
- LoserCheems
8+
- Evanwu1125
9+
- SNHuan
10+
- Thanksyy
11+
- ftgreat
12+
- zacliu2023
13+
- juliohsu
14+
- wubingheng111
715

816
---
917

‎.github/ISSUE_TEMPLATE/performance_issue.md‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,16 @@
22
name: Performance issue
33
about: Report performance problems or optimization opportunities
44
title: '[PERFORMANCE] '
5-
labels: 'performance'
6-
assignees: ''
5+
labels: ["performance"]
6+
assignees:
7+
- LoserCheems
8+
- Evanwu1125
9+
- SNHuan
10+
- Thanksyy
11+
- ftgreat
12+
- zacliu2023
13+
- juliohsu
14+
- wubingheng111
715

816
---
917

@@ -41,8 +49,8 @@ If you have profiling data (from nsys, nvprof, or PyTorch profiler), please incl
4149
**System Information**
4250
- GPU model and memory: [e.g., RTX 4090 24GB]
4351
- CUDA Compute Capability: [e.g., 8.9]
44-
- CPU: [e.g., Intel i9-12900K]
45-
- RAM: [e.g., 32GB DDR4]
52+
- CPU: [e.g., Intel i9-14900K]
53+
- RAM: [e.g., 64GB DDR4]
4654

4755
**Additional Context**
4856
- Is this a regression from a previous version?

‎.github/PULL_REQUEST_TEMPLATE/bug_fix.md‎

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 does this fix?
11+
12+
## Root Cause
13+
- Brief analysis of the cause.
14+
15+
## Changes
16+
- Code-level changes (modules, functions, APIs).
17+
18+
## Reproduction
19+
- Minimal reproducible example (MRE) or steps.
20+
21+
## Tests
22+
- New/updated tests and how you validated.
23+
24+
## Compatibility
25+
- Backward-compatibility notes, migration if any.
26+
27+
## Checklist
28+
- [ ] Linked issue provided
29+
- [ ] Adds or updates tests
30+
- [ ] Updates docs if needed
31+
- [ ] No perf regressions

‎.github/PULL_REQUEST_TEMPLATE/feature_support.md‎

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: "Introduce a new feature with design context and tests"
4+
title: "[FEATURE SUPPORT] "
5+
labels: ["feature"]
6+
7+
---
8+
9+
## Summary
10+
- What feature is added? Motivation and context.
11+
12+
## Design
13+
- Brief design or architecture. Alternatives considered.
14+
15+
## Changes
16+
- New or changed public APIs, config, CLI.
17+
18+
## Implementation Notes
19+
- Key components, tricky parts.
20+
21+
## Tests
22+
- Unit or integration tests and coverage.
23+
24+
## Docs
25+
- User docs or examples updated?
26+
27+
## Checklist
28+
- [ ] Linked issue provided
29+
- [ ] API stable
30+
- [ ] Tests added or updated
31+
- [ ] Docs added or updated
32+
- [ ] No known performance regressions

‎.github/PULL_REQUEST_TEMPLATE/performance_optimization.md‎

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+
## Summary
9+
- What is optimized and why.
10+
11+
## Baseline
12+
- Current perf numbers and environment.
13+
14+
## Approach
15+
- Techniques used.
16+
17+
## Results
18+
- Before and after benchmarks.
19+
- Provide commands or script to reproduce benchmarks.
20+
21+
## Impact
22+
- Memory and throughput tradeoffs, hardware notes.
23+
24+
## Risks
25+
- Edge cases, correctness risks, gating tests.
26+
27+
## Checklist
28+
- [ ] Linked issue provided
29+
- [ ] Benchmarks included and reproducible
30+
- [ ] No accuracy regression
31+
- [ ] Docs updated

‎.github/auto_assign.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
addReviewers: true
2+
addAssignees: true
3+
4+
# If true, adds reviewers/assignees only if PR author is not in the list
5+
skipUsers:
6+
- dependabot[bot]
7+
8+
reviewers:
9+
- LoserCheems
10+
- Evanwu1125
11+
- SNHuan
12+
- Thanksyy
13+
- ftgreat
14+
- zacliu2023
15+
- juliohsu
16+
- wubingheng111
17+
18+
assignees:
19+
- LoserCheems
20+
- Evanwu1125
21+
- SNHuan
22+
- Thanksyy
23+
- ftgreat
24+
- zacliu2023
25+
- juliohsu
26+
- wubingheng111
27+
28+
numberOfReviewers: 8

‎.github/pull_request_template.md‎

Lines changed: 0 additions & 93 deletions
This file was deleted.

‎.github/workflows/auto-assign.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Auto assign reviewers and assignees
2+
3+
on:
4+
pull_request_target:
5+
types: [opened, ready_for_review]
6+
7+
permissions:
8+
pull-requests: write
9+
contents: read
10+
11+
jobs:
12+
add-reviewers:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: kentaro-m/[email protected]
16+
with:
17+
repo-token: ${{ secrets.GITHUB_TOKEN }}
18+
configuration-path: .github/auto_assign.yml

0 commit comments

Comments
 (0)