You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
stale-issue-message: 'This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. If this is still relevant, please comment to keep it open.'
16
+
close-issue-message: 'Closed due to inactivity. Feel free to reopen with new information.'
stale-pr-message: 'This PR has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs.'
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+41-13Lines changed: 41 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,17 +2,32 @@
2
2
3
3
Thanks for your interest in improving the Notetaker skill. This is a single-file product, so contributions tend to be focused and high-impact.
4
4
5
+
## Before You Start
6
+
7
+
**Open an issue first.** All contributions start as an issue - bug report, feature request, or skill improvement. Wait for a `confirmed` or `help-wanted` label before starting work. This prevents wasted effort on changes that don't align with the project direction.
8
+
9
+
PRs without a linked issue will be closed with a note to open an issue first.
10
+
5
11
## License
6
12
7
-
This project uses MIT license. By submitting a pull request, you agree that your contributions are licensed under the same MIT license. No CLA required.
13
+
MIT license. By submitting a pull request, you agree that your contributions are licensed under the same terms. No CLA required.
14
+
15
+
## Design Principles
16
+
17
+
These guide every decision. PRs that conflict with these principles will be rejected:
18
+
19
+
1.**Minimal friction** - The skill exists to capture ideas before they're forgotten. Anything that adds steps or cognitive load works against this
20
+
2.**Small by design** - The skill file stays under ~1,500 words. Complexity lives in `references/`, not in the main file
21
+
3.**Capture, don't act** - Claude records and moves on. It never analyzes, expands, or offers to help with note content during capture
22
+
4.**Voice-first** - Primary use case is hands-free dictation. Triggers must work when spoken, not just typed
8
23
9
24
## What to Contribute
10
25
11
26
**High value:**
12
-
- New trigger patterns that feel natural
13
27
- Voice cleanup rule improvements (especially for non-English speakers)
Voice-friendly note capture for Claude. Capture ideas hands-free while driving, walking, or cooking. Fillers, false starts, and dictation artifacts are cleaned up automatically. Notes are organized into handoff files you can pick up in future sessions.
How this project is maintained, so contributors know what to expect.
4
+
5
+
## Contribution Flow
6
+
7
+
1.**Issue first** - All work starts as an issue. Bug reports, feature requests, and improvements go through issue templates
8
+
2.**Triage** - Issues are reviewed within 48 hours and labelled: `confirmed`, `help-wanted`, `cannot-reproduce`, or closed with explanation
9
+
3.**PR** - Once an issue has `confirmed` or `help-wanted`, contributors can fork, branch, and submit a PR referencing the issue
10
+
4.**Review** - PRs are reviewed within 72 hours. One round of revision if needed
11
+
5.**Merge** - Squash merge to keep history clean. CHANGELOG updated with each release
12
+
13
+
## Bug Severity
14
+
15
+
| Label | Definition | Response Time |
16
+
|-------|-----------|---------------|
17
+
|`critical`| Skill breaks Claude's behaviour (e.g., acts on note content, ignores triggers entirely) | Fixed within 1 week by maintainer |
18
+
|`minor`| Edge case, cosmetic, or non-blocking issue | Labelled `help-wanted` for community |
19
+
20
+
## Versioning
21
+
22
+
This project uses [Semantic Versioning](https://semver.org/):
23
+
24
+
-**Patch** (3.0.x) - Bug fixes, typo corrections
25
+
-**Minor** (3.x.0) - New triggers, new reference files, non-breaking improvements
26
+
-**Major** (x.0.0) - Breaking changes to skill structure, trigger removals
27
+
28
+
## Release Process
29
+
30
+
1. Changes merged to `main` via squash merge
31
+
2. CHANGELOG.md updated
32
+
3. Git tag created (e.g., `v3.0.1`)
33
+
4. GitHub Release published with CHANGELOG entry as notes
34
+
35
+
## Branch Protection
36
+
37
+
- All changes to `main` go through PRs
38
+
- CI must pass before merge
39
+
- Maintainer approval required
40
+
- Squash merge only
41
+
42
+
## Stale Issues
43
+
44
+
- Issues with no activity for 30 days receive a `stale` label
45
+
- 14 more days of silence and the issue is closed
46
+
- Stale issues can be reopened with new information
47
+
48
+
## If a Bad Merge Gets Through
49
+
50
+
1. Revert via `git revert` (not force push)
51
+
2. Comment on the original PR explaining what broke
52
+
3. Open a new issue for the proper fix
53
+
54
+
## Decision Log
55
+
56
+
Non-obvious design decisions are recorded in `docs/decisions/`. Format: `YYYY-MM-DD-decision-title.md` with context, options considered, and reasoning. This prevents re-litigating settled decisions.
0 commit comments