Skip to content

Commit b827017

Browse files
authored
Add lightweight maintenance templates (#18)
1 parent da9d426 commit b827017

3 files changed

Lines changed: 73 additions & 0 deletions

File tree

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Retrospective / experiment note
3+
about: Capture what changed, what was learned, and what should happen next.
4+
title: "[review] "
5+
labels: ""
6+
assignees: ""
7+
---
8+
9+
## Context
10+
11+
<!-- What was the goal, experiment, bug, or decision? -->
12+
13+
## What happened
14+
15+
<!-- What changed, failed, worked, or surprised me? -->
16+
17+
## What I learned
18+
19+
<!-- Keep the useful lesson, trade-off, or design constraint. -->
20+
21+
## Follow-up
22+
23+
- [ ]

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!-- Keep this short and honest. Delete sections that do not apply. -->
2+
3+
## Summary
4+
5+
<!-- What changed and why? One logical change per pull request. -->
6+
7+
## Evidence
8+
9+
- [ ] Checks run:
10+
- [ ] Docs, screenshots, traces, or sample output updated if relevant:
11+
- [ ] Report or issue linked if relevant:
12+
13+
## Review focus
14+
15+
<!-- What would be most useful for someone to review? -->
16+
17+
## Notes
18+
19+
<!-- Trade-offs, follow-ups, release note, or out-of-scope items. -->
20+
21+
Closes #

docs/reports/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Reports
2+
3+
Use this folder for experiment reports, release notes, and retrospectives that need more context than a pull request description.
4+
5+
Prefer one short file per experiment or milestone:
6+
7+
- `YYYY-MM-DD-topic.md`
8+
9+
## Template
10+
11+
### Question
12+
13+
What am I trying to learn, prove, or compare?
14+
15+
### Setup
16+
17+
Input, scenario, command, configuration, and any important assumptions.
18+
19+
### Result
20+
21+
Metrics, qualitative observations, or links to generated artifacts.
22+
23+
### Interpretation
24+
25+
What the result means, what changed my mind, and what remains uncertain.
26+
27+
### Follow-up
28+
29+
- [ ]

0 commit comments

Comments
 (0)