Skip to content

Commit 9f661e9

Browse files
jxtngxjxtngx
committed
improve agileness
1 parent dd5e54f commit 9f661e9

File tree

15 files changed

+954
-1
lines changed

15 files changed

+954
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,31 @@ assignees: ''
3737
I want to fix the LocalStackEmulator failing to mock SageMaker endpoints
3838
So that I can test deployment workflows locally before using AWS
3939

40+
## Acceptance Criteria
41+
- [ ] [Specific, testable criteria for bug fix validation]
42+
- [ ] [Another measurable criteria]
43+
- [ ] [Performance/behavior requirement after fix]
44+
45+
## Definition of Done
46+
- [ ] Bug reproduced and root cause identified
47+
- [ ] Fix implemented and unit tests written
48+
- [ ] All existing tests pass
49+
- [ ] Code reviewed by appropriate agent/team member
50+
- [ ] Documentation updated if needed
51+
- [ ] No regression in related functionality
52+
- [ ] Performance impact assessed
53+
54+
## Severity
55+
- [ ] **Critical** - Production down, data loss, security vulnerability
56+
- [ ] **High** - Major functionality broken, no workaround
57+
- [ ] **Medium** - Functionality impaired, workaround available
58+
- [ ] **Low** - Minor issue, cosmetic, edge case
59+
60+
## Estimated Effort
61+
- [ ] **Small** (1-3 story points) - Few hours
62+
- [ ] **Medium** (5-8 story points) - 1-2 days
63+
- [ ] **Large** (13+ story points) - 3+ days
64+
4065
---
4166

4267
### Additional Context
@@ -46,6 +71,23 @@ assignees: ''
4671
[Paste complete error output here]
4772
```
4873

74+
**Environment:**
75+
- PyTorch version:
76+
- Python version:
77+
- OS:
78+
- GPU/CUDA version (if applicable):
79+
80+
**Steps to Reproduce:**
81+
1. [First step]
82+
2. [Second step]
83+
3. [...]
84+
85+
**Expected Behavior:**
86+
[What should happen]
87+
88+
**Actual Behavior:**
89+
[What actually happens]
90+
4991
**Screenshots/Logs:**
5092
[If applicable, add visual evidence]
5193

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Copyright 2025 jxtngx | Apache 2.0 License
2+
# GitHub Issue Template Configuration
3+
4+
blank_issues_enabled: false
5+
6+
contact_links:
7+
- name: Documentation
8+
url: https://github.com/jxtngx/claude-code-pytorch/tree/main/docs
9+
about: Check project documentation for guides and ADRs
10+
11+
- name: Sprint Planning
12+
url: https://github.com/jxtngx/claude-code-pytorch/tree/main/docs/sprints
13+
about: View current sprint status and planning documents
14+
15+
- name: Architecture Decisions
16+
url: https://github.com/jxtngx/claude-code-pytorch/tree/main/docs/adr
17+
about: Review Architecture Decision Records
18+
19+
- name: Discussions
20+
url: https://github.com/jxtngx/claude-code-pytorch/discussions
21+
about: Ask questions and discuss ideas with the community

‎.github/ISSUE_TEMPLATE/epic.md‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
---
2+
name: Epic
3+
about: Define a large feature or initiative spanning multiple sprints
4+
title: '[EPIC] '
5+
labels: 'epic'
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Copyright 2025 jxtngx | Apache 2.0 License | https://github.com/jxtngx/claude-code-pytorch -->
11+
12+
## Epic Overview
13+
14+
**Epic Title**: [Descriptive name for the epic]
15+
16+
**Business Value Statement**:
17+
As [stakeholder group]
18+
We want to [achieve goal]
19+
So that [business value/outcome]
20+
21+
## Strategic Alignment
22+
- **Project Goal**: [How this epic supports project objectives]
23+
- **Success Metrics**: [KPIs or measurable outcomes]
24+
- **Target Release**: [Version or quarter]
25+
26+
## Scope
27+
28+
### In Scope
29+
- [Major feature or capability 1]
30+
- [Major feature or capability 2]
31+
- [Major feature or capability 3]
32+
33+
### Out of Scope
34+
- [Explicitly excluded item 1]
35+
- [Explicitly excluded item 2]
36+
37+
## User Stories
38+
<!-- Link to child stories that compose this epic -->
39+
- [ ] #[story_number] - [Story title] (X points)
40+
- [ ] #[story_number] - [Story title] (X points)
41+
- [ ] #[story_number] - [Story title] (X points)
42+
- [ ] #[story_number] - [Story title] (X points)
43+
44+
**Total Story Points**: [Sum]
45+
46+
## Definition of Done for Epic
47+
- [ ] All child stories completed and accepted
48+
- [ ] End-to-end testing completed
49+
- [ ] Performance benchmarks met
50+
- [ ] Documentation complete (user guide, API docs, architecture)
51+
- [ ] Security review completed
52+
- [ ] Deployed to production
53+
- [ ] Monitoring and alerts configured
54+
- [ ] Stakeholder sign-off received
55+
56+
## Timeline
57+
- **Start Sprint**: [Sprint X]
58+
- **Target Completion**: [Sprint Y]
59+
- **Estimated Duration**: [Z sprints]
60+
61+
## Milestones
62+
| Milestone | Target Sprint | Status | Notes |
63+
|-----------|--------------|--------|-------|
64+
| [Milestone 1] | Sprint X | | |
65+
| [Milestone 2] | Sprint Y | | |
66+
| [Milestone 3] | Sprint Z | | |
67+
68+
## Dependencies
69+
### Depends On
70+
- [Other epic or external dependency]
71+
- [Technical prerequisite]
72+
73+
### Depended On By
74+
- [Epics or features that depend on this]
75+
76+
## Technical Architecture
77+
<!-- High-level technical approach -->
78+
- **Components Affected**: [List major components]
79+
- **Integration Points**: [External systems or APIs]
80+
- **Data Models**: [New or modified data structures]
81+
- **Performance Requirements**: [Latency, throughput, etc.]
82+
83+
## Risk Assessment
84+
| Risk | Probability | Impact | Mitigation |
85+
|------|------------|--------|------------|
86+
| [Risk 1] | High/Med/Low | High/Med/Low | [Strategy] |
87+
| [Risk 2] | High/Med/Low | High/Med/Low | [Strategy] |
88+
89+
## Resource Requirements
90+
- **Agent Teams**: [Which agent teams are involved]
91+
- **Infrastructure**: [AWS resources, GPU requirements]
92+
- **External Resources**: [Third-party services, datasets]
93+
94+
## Progress Tracking
95+
- **Completed Stories**: X / Y
96+
- **Story Points Delivered**: X / Total
97+
- **Current Sprint Focus**: [What's being worked on now]
98+
- **Blockers**: [Current impediments]
99+
100+
## Acceptance Criteria for Epic
101+
- [ ] [High-level acceptance criterion 1]
102+
- [ ] [High-level acceptance criterion 2]
103+
- [ ] [High-level acceptance criterion 3]
104+
- [ ] [Performance criterion]
105+
- [ ] [Quality criterion]
106+
107+
## Communication Plan
108+
- **Stakeholders**: [List key stakeholders]
109+
- **Update Frequency**: [Weekly/Sprint reviews]
110+
- **Demo Schedule**: [When to show progress]
111+
112+
## Related Documentation
113+
- Design Doc: [link]
114+
- ADR: [link to relevant ADRs]
115+
- Technical Spec: [link]
116+
- Test Plan: [link]

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,39 @@ assignees: ''
3737
I want to add distributed data parallel training across multi-node EC2 clusters
3838
So that I can scale training to datasets larger than single-node memory
3939

40+
## Acceptance Criteria
41+
- [ ] [Specific, measurable success criteria]
42+
- [ ] [Performance requirement or benchmark]
43+
- [ ] [Integration requirement]
44+
- [ ] [User-facing behavior]
45+
46+
## Definition of Done
47+
- [ ] Feature implemented with full test coverage (>90%)
48+
- [ ] Documentation written (user guide and API docs)
49+
- [ ] Code reviewed by relevant agent/team member
50+
- [ ] Integration tests passing
51+
- [ ] Performance benchmarks met
52+
- [ ] Example usage provided
53+
- [ ] No breaking changes (or migration guide provided)
54+
- [ ] Deployed to test environment successfully
55+
56+
## Priority (MoSCoW)
57+
- [ ] **Must Have** - Critical for current sprint/release
58+
- [ ] **Should Have** - Important but not critical
59+
- [ ] **Could Have** - Nice to have if time permits
60+
- [ ] **Won't Have** - Future consideration
61+
62+
## Story Points Estimate
63+
- [ ] **Small** (1-3 points) - 1-2 days
64+
- [ ] **Medium** (5-8 points) - 3-5 days
65+
- [ ] **Large** (13 points) - 1-2 weeks
66+
- [ ] **XL** (21+ points) - Consider breaking into epic
67+
68+
## Epic/Sprint Assignment
69+
- **Epic**: [Link to epic if applicable]
70+
- **Target Sprint**: [Sprint number or "Backlog"]
71+
- **Dependencies**: [List any blocking issues/features]
72+
4073
---
4174

4275
### Additional Context
@@ -47,6 +80,12 @@ assignees: ''
4780
**Example Use Cases:**
4881
[Concrete scenarios where this feature provides value]
4982

83+
**Technical Approach:**
84+
[High-level implementation strategy]
85+
86+
**Alternatives Considered:**
87+
[Other approaches and why this one is preferred]
88+
5089
**Screenshots/Diagrams:**
5190
[If applicable, add visual aids]
5291

‎.github/ISSUE_TEMPLATE/spike.md‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
---
2+
name: Spike
3+
about: Time-boxed research or investigation task
4+
title: '[SPIKE] '
5+
labels: 'spike, research'
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Copyright 2025 jxtngx | Apache 2.0 License | https://github.com/jxtngx/claude-code-pytorch -->
11+
12+
## Spike Overview
13+
14+
**Research Question**: [What are we trying to learn or prove?]
15+
16+
**Context**: [Why is this investigation needed?]
17+
18+
## Objectives
19+
- [ ] [Specific question to answer or hypothesis to test]
20+
- [ ] [Technical feasibility to assess]
21+
- [ ] [Risk or uncertainty to resolve]
22+
23+
## Timebox
24+
- **Maximum Duration**: [X days/hours]
25+
- **Sprint**: [Sprint number]
26+
- **Start Date**: [YYYY-MM-DD]
27+
- **End Date**: [YYYY-MM-DD]
28+
29+
## Success Criteria
30+
The spike is successful if we can:
31+
- [ ] Answer the research question definitively
32+
- [ ] Provide recommendation with confidence level
33+
- [ ] Identify risks and mitigation strategies
34+
- [ ] Estimate effort for implementation
35+
- [ ] Create proof of concept (if applicable)
36+
37+
## Research Approach
38+
1. [Investigation step 1]
39+
2. [Investigation step 2]
40+
3. [Investigation step 3]
41+
42+
## Areas to Investigate
43+
- **Technical Feasibility**: [What technical aspects to explore]
44+
- **Performance Impact**: [Benchmarks or metrics to measure]
45+
- **Integration Complexity**: [Systems or components to consider]
46+
- **Alternative Solutions**: [Options to evaluate]
47+
48+
## Deliverables
49+
- [ ] **Research Summary**: Document findings and recommendations
50+
- [ ] **Proof of Concept**: Working prototype or code sample
51+
- [ ] **Decision Matrix**: Comparison of alternatives
52+
- [ ] **Risk Assessment**: Identified risks and mitigations
53+
- [ ] **Story Breakdown**: User stories if moving forward
54+
- [ ] **Effort Estimate**: Story points for implementation
55+
56+
## Constraints
57+
- **Time Limit**: [Strict timebox - do not exceed]
58+
- **Resources**: [Available tools, data, compute]
59+
- **Scope Boundaries**: [What NOT to investigate]
60+
61+
## Questions to Answer
62+
1. [Critical question 1]?
63+
2. [Critical question 2]?
64+
3. [Critical question 3]?
65+
66+
## Definition of Done for Spike
67+
- [ ] Research completed within timebox
68+
- [ ] Findings documented and shared
69+
- [ ] Recommendation provided with rationale
70+
- [ ] Next steps identified
71+
- [ ] Knowledge transfer completed
72+
- [ ] ADR created if architectural decision made
73+
74+
## Related Items
75+
- **Parent Epic**: #[epic_number]
76+
- **Blocked Stories**: #[story_numbers]
77+
- **Similar Research**: [Links to related spikes or docs]
78+
79+
---
80+
81+
## Research Log
82+
<!-- Update this section during the spike -->
83+
84+
### Day 1: [Date]
85+
**Investigated**:
86+
**Findings**:
87+
**Next Steps**:
88+
89+
### Day 2: [Date]
90+
**Investigated**:
91+
**Findings**:
92+
**Next Steps**:
93+
94+
---
95+
96+
## Conclusions
97+
<!-- Complete at end of spike -->
98+
99+
### Summary of Findings
100+
[Key discoveries and insights]
101+
102+
### Recommendation
103+
- [ ] **Proceed** - Move forward with implementation
104+
- [ ] **Pivot** - Change approach based on findings
105+
- [ ] **Stop** - Do not proceed, not feasible
106+
- [ ] **Further Research** - Need additional spike
107+
108+
### Rationale
109+
[Explanation for recommendation]
110+
111+
### Estimated Effort
112+
[Story points if proceeding]
113+
114+
### Risks Identified
115+
| Risk | Probability | Impact | Mitigation |
116+
|------|------------|--------|------------|
117+
| | | | |
118+
119+
### Next Actions
120+
- [ ] [Immediate next step]
121+
- [ ] [Follow-up action]

0 commit comments

Comments
 (0)