Skip to content

docs: Add guidance to prevent working around problems#11

Merged
JeffreyUrban merged 2 commits intomainfrom
docs/fix-workaround-guidance
Dec 17, 2025
Merged

docs: Add guidance to prevent working around problems#11
JeffreyUrban merged 2 commits intomainfrom
docs/fix-workaround-guidance

Conversation

@JeffreyUrban
Copy link
Copy Markdown
Owner

Summary

Add comprehensive guidance to prevent the pattern of creating workarounds instead of fixing root problems.

Changes

1. CLAUDE.md - Critical Rules

Added "Never Work Around Problems - Fix Them" section with:

  • Mandatory questions to ask before proposing solutions
  • Red flags indicating workarounds
  • Required actions when encountering blocking issues

2. CLAUDE.md - Problem-Solving Standards

Added "Apologies and Promises Are Not Solutions" section requiring:

  • Concrete documentation changes instead of apologies
  • Specific guidance updates to prevent recurrence
  • Rejection of vague promises without actionable changes

3. .claude/workflows/fixing-issues.md

New workflow document with:

  • Universal rule to fix issues completely
  • Examples of wrong (workaround) vs right (fixing) approaches
  • Decision tree for evaluating conditional logic

Context

These changes resulted from a pattern where test failures were worked around by adding conditional logic to skip tests, rather than fixing the root cause (template placeholders in the Homebrew formula).

The guidance now enforces:

  • Treating all blocking issues as in-scope
  • Fixing root causes before proceeding
  • Documenting prevention strategies in guidance files

Testing

These guidance changes have been applied to fix the actual Homebrew formula issues:

  • Removed the test-skipping workaround commit
  • Populated formula with real package data from PyPI
  • Added missing libyaml dependency
  • CI now passing on homebrew-tui-delta main branch

🤖 Generated with Claude Code

JeffreyUrban and others added 2 commits December 11, 2025 20:38
Add comprehensive workflow document that enforces:
- Treating all blocking issues as in-scope
- Fixing root causes instead of adding workarounds
- Rejecting conditional logic that bypasses problems

This completes the guidance changes to prevent the pattern of
hiding issues with test-skipping logic or deferring fixes.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add two new critical sections to CLAUDE.md:

1. "Never Work Around Problems - Fix Them"
   - Mandatory questions before proposing solutions
   - Red flags indicating workarounds vs fixes
   - Required actions for blocking issues
   - Examples of wrong (workaround) vs right (fix) approaches

2. "Apologies and Promises Are Not Solutions"
   - Requirement for concrete documentation changes
   - Rejection of vague promises without actionable changes
   - Process for identifying and updating failed guidance

These sections prevent the pattern of creating workarounds (like
skipping tests) instead of fixing root causes (like template
placeholders in formulas).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@codecov
Copy link
Copy Markdown

codecov bot commented Dec 12, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@JeffreyUrban JeffreyUrban merged commit 7052b3e into main Dec 17, 2025
9 checks passed
@JeffreyUrban JeffreyUrban deleted the docs/fix-workaround-guidance branch December 17, 2025 01:43
@JeffreyUrban JeffreyUrban restored the docs/fix-workaround-guidance branch December 20, 2025 21:27
@JeffreyUrban JeffreyUrban deleted the docs/fix-workaround-guidance branch December 20, 2025 21:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant