Skip to content

docs: add harness engineering cross-reference in CONTRIBUTING.md#615

Merged
carlos-alm merged 3 commits intomainfrom
docs/contributing-cross-refs
Mar 26, 2026
Merged

docs: add harness engineering cross-reference in CONTRIBUTING.md#615
carlos-alm merged 3 commits intomainfrom
docs/contributing-cross-refs

Conversation

@carlos-alm
Copy link
Contributor

Summary

  • Add a reference to docs/contributing/harness-engineering.md in the Common Contribution Types section, so contributors working on Claude Code hooks can find the guide
  • The adding-a-language guide was already linked

Point contributors to docs/contributing/harness-engineering.md for
Claude Code hook work.
@claude
Copy link

claude bot commented Mar 26, 2026

Claude finished @carlos-alm's task —— View job


Reviewing PR #615: docs cross-reference addition

Todo List:

  • Read the modified CONTRIBUTING.md file
  • Verify the referenced harness-engineering.md file exists
  • Apply 5-phase review process
  • Evaluate backlog compliance
  • Provide final assessment and rating

Root Cause Analysis

Problem Being Solved: Contributors working on Claude Code hooks need better discoverability of the harness engineering guide. Currently, the adding-a-language guide was referenced, but the harness engineering guide was "orphaned" - not linked from the main contributing document.

Why This Approach: Adding a cross-reference in the "Common Contribution Types" section creates logical navigation for developers working on different types of contributions. This follows the existing pattern established by the "Adding a New Language" reference.

Risk Assessment: Zero risk - this is purely additive documentation with no code changes.

Configuration Change Detection

No configuration changes detected - this is pure documentation.

Test Integrity

No test changes - documentation-only change.

Code Quality

No code changes - this is documentation enhancement only.

Backlog Compliance

  • Zero-dep: ✓ — No runtime dependencies added
  • Foundation-aligned: ✓ — Improves developer experience without violating any principles
  • Problem-fit: 3 — Useful organizational improvement, doesn't directly address core "lost AI" problem but improves contributor workflow
  • Breaking: No — Purely additive documentation change
  • Tier: 1 (zero-dep ✓ + foundation-aligned ✓)

Critical Concerns

None identified. This is a straightforward documentation improvement.

Changes Review

Lines 267-272 in CONTRIBUTING.md:

### Harness Engineering (Claude Code Hooks)

If you're working on the Claude Code hooks in `.claude/hooks/`, see the dedicated guide:

**[Harness Engineering Guide](docs/contributing/harness-engineering.md)**

This covers the principles behind AI agent harnesses, how our hooks work, and how to add or modify them.

The change:

  • ✅ Follows existing formatting patterns
  • ✅ Uses consistent markdown structure
  • ✅ References a file that actually exists
  • ✅ Provides helpful context about what the guide covers
  • ✅ Logically placed in the "Common Contribution Types" section

Final Recommendation

  • Rating: ⭐⭐⭐⭐☆ (4/5)
  • Action: APPROVE
  • Reasoning: Clean, well-executed documentation improvement that enhances contributor experience. Follows existing patterns, references valid content, and addresses a real discoverability gap. Only minor consideration is that it doesn't directly solve the core technical problem the project addresses, but documentation improvements are valuable for project health.

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Mar 26, 2026

Greptile Summary

This PR adds a cross-reference entry in CONTRIBUTING.md pointing contributors to docs/contributing/harness-engineering.md when working on Claude Code hooks in .claude/hooks/. The new section follows the same structure already used by the "Adding a New Language" entry (bold link + one-sentence description), and the target file already exists in the repo. No code changes — documentation only.

Confidence Score: 5/5

Documentation-only change; safe to merge immediately.

Single documentation file edited, linked target file verified to exist, pattern matches existing sections — no risk of runtime impact.

No files require special attention.

Important Files Changed

Filename Overview
CONTRIBUTING.md Adds a "Harness Engineering (Claude Code Hooks)" section linking to docs/contributing/harness-engineering.md, which exists in the repo; no broken links, follows existing section pattern.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[CONTRIBUTING.md\nCommon Contribution Types] --> B[Adding a New Language\ndocs/contributing/adding-a-language.md]
    A --> C[Harness Engineering NEW\ndocs/contributing/harness-engineering.md]
    A --> D[Parser Improvements\ninline steps]
    A --> E[Documentation\ninline guidance]
    C --> F[.claude/hooks/\nhook files]
Loading

Reviews (2): Last reviewed commit: "Merge remote-tracking branch 'origin/mai..." | Re-trigger Greptile

…ss-refs

Impact: 1 functions changed, 2 affected
@carlos-alm
Copy link
Contributor Author

@greptileai

@carlos-alm carlos-alm merged commit 0163eab into main Mar 26, 2026
12 checks passed
@carlos-alm carlos-alm deleted the docs/contributing-cross-refs branch March 26, 2026 06:55
@github-actions github-actions bot locked and limited conversation to collaborators Mar 26, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant