Repository navigation
skills(running-tend): weigh the root-cause fix in every workflow, not just triage #4086
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
1cb24a7
77d3988
b05d052
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -140,6 +140,23 @@ The codecov-failure dismissal pattern is different and remains correct: | |
| `codecov/patch`, so dismissing the approval until the coverage gap is | ||
| addressed is intentional. | ||
|
|
||
| ## Weigh the root-cause fix before shipping a workaround | ||
|
|
||
| When a mismatch, a false positive, or a stale value has an obvious non-code | ||
| workaround (a template change, a config value, an alias, a comment recording | ||
| the drift), don't stop there. First check whether the workaround is **lossy or | ||
| foot-gunny**, and weigh a proportionate **root-cause code fix** before opening | ||
| a docs-only PR. A "docs-only, no risk" framing is not the same as good | ||
| guidance — a zero-code-risk change can still steer users toward a | ||
| collision-prone or lossy config, and annotating a stale value leaves the | ||
| duplication that made it stale. If you do recommend a config change, surface | ||
| its downsides in the PR body up front, not only when challenged. | ||
|
worktrunk-bot marked this conversation as resolved.
Resolved
|
||
|
|
||
| This governs every workflow that opens a PR here, not just issue triage. The | ||
| nightly sweep's #4069 annotated twelve stale VHS theme colors with | ||
|
Owner
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I thought we had guidance against giving references to specific historical events?
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes — Dropped the two incident sentences in |
||
| `(pre-Starlight; site is …)`; the maintainer replaced all twelve by reading | ||
| the hex properties out of `custom.css` at build time. | ||
|
|
||
| ## Issue Triage | ||
|
|
||
| When you need more information to diagnose a reported bug, the **primary | ||
|
|
@@ -228,17 +245,6 @@ across every repo. It's the project's preferred extension point. | |
| 5. Link to the [aliases docs](https://worktrunk.dev/extending/#aliases) and | ||
| [tips & patterns](https://worktrunk.dev/tips-patterns/). | ||
|
|
||
| ### Weigh the root-cause fix before shipping a config/docs workaround | ||
|
|
||
| When a mismatch or false-positive report has an obvious configurable | ||
| workaround (a template change, a config value, an alias), don't stop at | ||
| documenting it. First check whether the workaround is **lossy or | ||
| foot-gunny**, and weigh a proportionate **root-cause code fix** before | ||
| opening a docs-only PR. A "docs-only, no risk" framing is not the same as | ||
| good guidance — a zero-code-risk change can still steer users toward a | ||
| collision-prone or lossy config. If you do recommend a config change, | ||
| surface its downsides in the PR body up front, not only when challenged. | ||
|
|
||
| ### Don't fix tests by adding skip guards | ||
|
|
||
| When a test fails because production code or test setup can't handle some | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.