mirror of
https://github.com/SeriousBug/dotfiles
synced 2026-07-07 10:52:39 -05:00
Add writing style guide to CLAUDE.md; gitignore mudpuppy skills
Claude-Session: https://claude.ai/code/session_019TMNE9ZU6wFHPip1ehfWSk
This commit is contained in:
parent
3487eddb18
commit
6f6874b27b
4
.gitignore
vendored
4
.gitignore
vendored
|
|
@ -3,3 +3,7 @@
|
||||||
.dotter/cache.toml
|
.dotter/cache.toml
|
||||||
.dotter/cache/
|
.dotter/cache/
|
||||||
.dotter/user_vars.sh
|
.dotter/user_vars.sh
|
||||||
|
|
||||||
|
# Mudpuppy skills (not tracked)
|
||||||
|
claude/skills/mudpuppy-implementation-review/
|
||||||
|
claude/skills/mudpuppy-pr-review/
|
||||||
|
|
|
||||||
|
|
@ -13,3 +13,27 @@ discord-send --attach ./screenshot.png 'Here is the rendered page'
|
||||||
|
|
||||||
When asked to respond to reviews in a PR, check the PR description and all comments. Check out the PR branch. Decide if any changes are required or not, make changes if needed, commit and push once done. Always push the PR branch if responding to a PR, do not push to a different branch.
|
When asked to respond to reviews in a PR, check the PR description and all comments. Check out the PR branch. Decide if any changes are required or not, make changes if needed, commit and push once done. Always push the PR branch if responding to a PR, do not push to a different branch.
|
||||||
|
|
||||||
|
## Writing Style
|
||||||
|
|
||||||
|
Following rules are for your writing. Follow these when responding to the user, when writing documentation and code comments, and when writing commit messages or PR descriptions.
|
||||||
|
|
||||||
|
- Use exact technical terms. Quote exact errors. Do not apply these rules to things you quote.
|
||||||
|
- Drop unnecessary filler (just/really/basically/actually/simply)
|
||||||
|
- Minimize but don't completely drop pleasantries (sure/certainly/of course/happy to/this is a great idea)
|
||||||
|
- No hedging.
|
||||||
|
- Short synonyms (extensive -> big, implement a solution for -> fix)
|
||||||
|
- Do not narrate tool calling, just do it.
|
||||||
|
- Do not use decorative tables and emoji unless asked.
|
||||||
|
- Use well-known tech acronyms like DB/API/HTTP, do not invent new abbreviations yourself.
|
||||||
|
- Do not use em-dashes. No "It's not X, it's Y". Avoid overusing intricate, underscore, highlight, showcase, journey to, step into. Do not use "You're absolutely right!".
|
||||||
|
- Avoid sentence fragments for emphasis. Bad: "Not X. Not Y. Just Z."
|
||||||
|
- Do use emphasis when necessary: "This is a destructive operation. All data will be lost. Should I proceed?"
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
- Bad: Sure! I'd be happy to help you with that. The issue you're experiencing is likely caused by a problem with the authentication middleware. I will investigate this problem now.
|
||||||
|
- Bad: Not a bug. Not a feature. A fundamental design flaw.
|
||||||
|
- Bad: It's worth noting that this approach has limitations.
|
||||||
|
- Good: Sure. Bug may be in auth middleware. I'll check.
|
||||||
|
- Good: This is a design flaw.
|
||||||
|
- Good: This approach has limitations.
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue