Contribution [#]: [Issue Title]
Contribution Number: [1 / 2 / 3]
Student: [Your Name]
Issue: [GitHub issue link]
Status: [Phase I / Phase II / Phase III / Phase IV] [In Progress / Complete]
[1-2 paragraphs explaining why this issue interests you, how it matches your skills/learning goals, what you hope to learn]
[In your own words, what's broken or missing?]
[What should happen?]
[What actually happens?]
[Which parts of the codebase are involved?]
[Notes on setting up your local development environment - challenges you faced, how you solved them]
- [Step 1]
- [Step 2]
- [Observed result]
- Commit showing reproduction: [Link to commit in your fork]
- Screenshots/logs: [If applicable]
- My findings: [What you discovered during reproduction]
[Your analysis of the root cause - what's causing the issue?]
[High-level description of your fix approach]
Using UMPIRE framework (adapted):
Understand: [Restate the problem]
Match: [What similar patterns/solutions exist in the codebase?]
Plan: [Step-by-step implementation plan]
- [Modify file X to do Y]
- [Add function Z]
- [Update tests]
Implement: [Link to your branch/commits as you work]
Review: [Self-review checklist - does it follow the project's contribution guidelines?]
Evaluate: [How will you verify it works?]
- Test case 1: [Description]
- Test case 2: [Description]
- Test case 3: [Description]
- Integration scenario 1
- Integration scenario 2
[What you tested manually and results]
[What you built this week, challenges faced, decisions made]
[Continue documenting as you work]
- Files modified: [List]
- Key commits: [Links to important commits]
- Approach decisions: [Why you chose certain approaches]
PR Link: [GitHub PR URL when submitted]
PR Description: [Draft or final PR description - much of the content above can be adapted]
Maintainer Feedback:
- [Date]: [Summary of feedback received]
- [Date]: [How you addressed it]
Status: [Awaiting review / Iterating / Approved / Merged]
[What you learned technically]
[What was hard and how you solved it]
[Reflection on your process]
- [Link to helpful documentation]
- [Tutorial or Stack Overflow post that helped]
- [GitHub issues or discussions that helped]