docs: add raise-issue skill for writing newcomer-readable issues - #134
Merged
Conversation
Issues here assume vocabulary the repo never explains — run vs request, ledger, governor, PriceFn, Micros, the BaseException on Halt — so a reader without repo history cannot tell a bug from the design. Adds a skill that structures an issue as context, problem, proposed approach, tradeoffs and non-scope, with the TokenOps terms worth defining, a rule to verify every file:line against source, and a filing checklist. Links it from the "Open an issue first" step in CONTRIBUTING. #128 is the worked example.
tishachawla-jg
approved these changes
Sep 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
.claude/skills/raise-issue/SKILL.md— a structure for writing issues in this repo — and links it from the "Open an issue first" step inCONTRIBUTING.md.Why
Issues here assume vocabulary the repo never explains anywhere: run vs request, ledger, governor,
PriceFn,Micros, whyHaltextendsBaseException. Without that, a reader cannot tell a bug from the design — several behaviours that look broken are deliberate invariants, and an issue that does not say so gets relitigated in review instead of fixed.The skill asks for four sections:
It also carries the terms worth defining, a rule to read every
file:linebefore citing it, a filing checklist, and title guidance drawn from existing issues.Worked example
#128 was rewritten against this structure. It reads as the before/after: context establishes the run model and where
PriceFnsits before naming any symptom, the problem section leads with a halted trajectory and walks back topricing.py:53, and non-scope pushes failure postures to #129 and gateway model selection to #133 — both of which were previously implicit and would have been assumed in scope.Notes
CONTRIBUTING.md.CHANGELOG.mdentry: theUnreleasedsection tracks library changes, and this does not alter the package. Happy to add one if you would rather track contributor tooling there./raise-issueapplies it; otherwise it reads as a plain checklist.🤖 Generated with Claude Code
https://claude.ai/code/session_01AVsDw5j9nQ2pgesFfW1yos