agentleFS
konveyor-ecosystemkonveyor-ecosystem/playpen-pf-mig-skills/ralph/CLAUDE.md

playpen-pf-mig-skills / ralph

CLAUDE.md2 starsChanged 7 months agoApache-2.0View on GitHub

You are an autonomous coding agent working on a software project. APPEND to progress.txt (never replace, always append): The learnings section is critical - it helps future iterations avoid repeating mistakes and understand the codebase better. If you discover a reusable pattern that future iterations should know, add it to the ## Codebase Patterns section at the TOP of progress.txt (create it if it doesn't exist). This section should consolidate the most important learnings: Only add patterns that are general…

2 other projects use a version of this.

Adopted by

Most recently taken up by

  • Other versions2 projects use a version of this.

    Word for word · 2

    1. snarktank/ralph★ 22k100% same
    2. tuongaz/billfox★ 0100% same

    Edited · 0

    None found.

    Wrote their own version · 0

    None found.

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository5 other files it gives its agents.

The file

Show its rules and text

We split this CLAUDE.md into the rules it gives an agent

24 rules. About 0 are common, 16 are distinctive, and 8 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈16

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 8

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Read the PRD at prd.json (in the same directory as this file)

    line 7
  2. Very specific:

    Read the progress log at progress.txt (check Codebase Patterns section first)

    line 8
  3. Very specific:

    Check you're on the correct branch from PRD branchName.

    line 9
  4. Distinctive:

    Run quality checks (e.g., typecheck, lint, test - use whatever your project requires)

    line 12
  5. Distinctive:

    Update CLAUDE.md files if you discover reusable patterns (see below)

    line 13
  6. Very specific:

    If checks pass, commit ALL changes with message: feat: [Story ID] - [Story Title]

    line 14
  7. Very specific:

    Update the PRD to set passes: true for the completed story

    line 15
  8. Very specific:

    If you discover a reusable pattern that future iterations should know, add it to the ## Codebase Patterns section at the TOP of …

    line 36
  9. Distinctive:

    Only add patterns that are general and reusable, not story-specific details.

    line 45
  10. Distinctive:

    Before committing, check if any edited files have learnings worth preserving in nearby CLAUDE.md files:

    line 49
  11. Distinctive:

    Identify directories with edited files: - Look at which directories you modified

    line 51
  12. Distinctive:

    Check for existing CLAUDE.md: - Look for CLAUDE.md in those directories or parent directories

    line 52
  13. Distinctive:

    Add valuable learnings: - If you discovered something future developers/agents should know:

    line 53
  14. Distinctive:

    Only update CLAUDE.md if you have genuinely reusable knowledge that would help future work in that directory.

    line 71
  15. Distinctive:

    ALL commits must pass your project's quality checks (typecheck, lint, test)

    line 75
  16. Distinctive:

    Do NOT commit broken code

    line 76
  17. Distinctive:

    Keep changes focused and minimal

    line 77
  18. Distinctive:

    Follow existing code patterns

    line 78
  19. Distinctive:

    Verify the UI changes work as expected

    line 85
  20. Distinctive:

    If no browser tools are available, note in your progress report that manual browser verification is needed.

    line 88
  21. Very specific:

    After completing a user story, check if ALL stories have passes: true.

    line 92
  22. Distinctive:

    If ALL stories are complete and passing, reply with: <promise>COMPLETE</promise>

    line 94
  23. Very specific:

    If there are still stories with passes: false, end your response normally (another iteration will pick up the next story).

    line 97
  24. Distinctive:

    Read the Codebase Patterns section in progress.txt before starting

    line 104

≈ “Common” is an estimate: at least 1 in 5 of the 26,980 CLAUDE.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
CLAUDE.md

Ralph Agent Instructions

You are an autonomous coding agent working on a software project.

Your Task

  1. Read the PRD at prd.json (in the same directory as this file)
  2. Read the progress log at progress.txt (check Codebase Patterns section first)
  3. Check you're on the correct branch from PRD branchName. If not, check it out or create from main.
  4. Pick the highest priority user story where passes: false
  5. Implement that single user story
  6. Run quality checks (e.g., typecheck, lint, test - use whatever your project requires)
  7. Update CLAUDE.md files if you discover reusable patterns (see below)
  8. If checks pass, commit ALL changes with message: feat: [Story ID] - [Story Title]
  9. Update the PRD to set passes: true for the completed story
  10. Append your progress to progress.txt

Progress Report Format

APPEND to progress.txt (never replace, always append):

## [Date/Time] - [Story ID]
- What was implemented
- Files changed
- **Learnings for future iterations:**
  - Patterns discovered (e.g., "this codebase uses X for Y")
  - Gotchas encountered (e.g., "don't forget to update Z when changing W")
  - Useful context (e.g., "the evaluation panel is in component X")
---

The learnings section is critical - it helps future iterations avoid repeating mistakes and understand the codebase better.

Consolidate Patterns

If you discover a reusable pattern that future iterations should know, add it to the ## Codebase Patterns section at the TOP of progress.txt (create it if it doesn't exist). This section should consolidate the most important learnings:

## Codebase Patterns
- Example: Use `sql<number>` template for aggregations
- Example: Always use `IF NOT EXISTS` for migrations
- Example: Export types from actions.ts for UI components

Only add patterns that are general and reusable, not story-specific details.

Update CLAUDE.md Files

Before committing, check if any edited files have learnings worth preserving in nearby CLAUDE.md files:

  1. Identify directories with edited files - Look at which directories you modified
  2. Check for existing CLAUDE.md - Look for CLAUDE.md in those directories or parent directories
  3. Add valuable learnings - If you discovered something future developers/agents should know:
    • API patterns or conventions specific to that module
    • Gotchas or non-obvious requirements
    • Dependencies between files
    • Testing approaches for that area
    • Configuration or environment requirements

Examples of good CLAUDE.md additions:

  • "When modifying X, also update Y to keep them in sync"
  • "This module uses pattern Z for all API calls"
  • "Tests require the dev server running on PORT 3000"
  • "Field names must match the template exactly"

Do NOT add:

  • Story-specific implementation details
  • Temporary debugging notes
  • Information already in progress.txt

Only update CLAUDE.md if you have genuinely reusable knowledge that would help future work in that directory.

Quality Requirements

  • ALL commits must pass your project's quality checks (typecheck, lint, test)
  • Do NOT commit broken code
  • Keep changes focused and minimal
  • Follow existing code patterns

Browser Testing (If Available)

For any story that changes UI, verify it works in the browser if you have browser testing tools configured (e.g., via MCP):

  1. Navigate to the relevant page
  2. Verify the UI changes work as expected
  3. Take a screenshot if helpful for the progress log

If no browser tools are available, note in your progress report that manual browser verification is needed.

Stop Condition

After completing a user story, check if ALL stories have passes: true.

If ALL stories are complete and passing, reply with: <promise>COMPLETE</promise>

If there are still stories with passes: false, end your response normally (another iteration will pick up the next story).

Important

  • Work on ONE story per iteration
  • Commit frequently
  • Keep CI green
  • Read the Codebase Patterns section in progress.txt before starting

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.