agentleFS
ritamghritamgh/claude-skills/skills/project-context/SKILL.md

project-context

Skill0 starsChanged 26 days agoMITView on GitHub

Maintain a concise, trustworthy PROJECT_CONTEXT.md map for a software repository. Use when onboarding to a repository, when the map is missing or stale, or after durable changes to architecture, commands, dependencies, services, workflows, feature ownership, or important file locations.

33 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use code-review.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • GoogleSkill

    code-review

    Adversarial systems, concurrency, memory-model, and architecture code review protocol. Use this skill whenever asked to review code, PRs, diffs, or branches in Filament.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

10 rules. 0 are common, 8 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 24 edited versions we read keep these.

  • 8

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

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

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

    Do not create PROJECT_CONTEXT.md in $HOME, a temporary directory, a dependency or vendor tree, a generated directory, or an unrelated …

    line 13
  2. Very specific:

    Read PROJECT_CONTEXT.md first when it exists.

    line 18
  3. Distinctive:

    Treat it as a guide, not as ground truth.

    line 19
  4. Distinctive:

    Verify claims relevant to the current task with targeted code and configuration reads.

    line 20
  5. Distinctive:

    If it is missing in a real writable repository, perform a lightweight survey before creating it.

    line 21
  6. Distinctive:

    Keep the document concise and navigational.

    line 32
  7. Distinctive:

    Update the map in the same session when a completed change affects:

    line 36
  8. Distinctive:

    Do not edit it merely to restate a small implementation detail that is obvious from the code.

    line 45
  9. Distinctive:

    Check every new path and command against the repository.

    line 51
  10. Distinctive:

    Remove stale statements discovered during the task.

    line 52

“Common” is measured: kept by at least 6 in 10 of the 24 edited versions of this file we could read. “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
SKILL.md

Project Context

Maintain PROJECT_CONTEXT.md as a compact navigation map for future development sessions.

Safety boundary

  1. Find the actual repository root with git rev-parse --show-toplevel or equivalent project evidence.
  2. Do not create PROJECT_CONTEXT.md in $HOME, a temporary directory, a dependency or vendor tree, a generated directory, or an unrelated parent directory.
  3. Preserve unrelated user changes. Do not overwrite useful project-specific documentation.

Start of work

  1. Read PROJECT_CONTEXT.md first when it exists.
  2. Treat it as a guide, not as ground truth.
  3. Verify claims relevant to the current task with targeted code and configuration reads.
  4. If it is missing in a real writable repository, perform a lightweight survey before creating it.

What the map should contain

  • A one-paragraph project purpose and architecture summary.
  • Important source, test, configuration, documentation, migration, and deployment paths.
  • Canonical install, build, lint, type-check, test, development, and deployment commands.
  • High-level data flow and external service boundaries.
  • Durable conventions, feature ownership, and debugging gotchas.
  • Links to authoritative existing documentation instead of duplicated detail.

Keep the document concise and navigational. Exclude chat history, transient task status, speculative notes, generated inventories, and implementation logs.

Update triggers

Update the map in the same session when a completed change affects:

  • architecture or data flow,
  • important file locations,
  • development, test, build, or deployment commands,
  • dependencies or external services,
  • durable feature behavior or ownership,
  • conventions and recurring debugging knowledge.

Do not edit it merely to restate a small implementation detail that is obvious from the code.

Verification

Before finishing:

  1. Check every new path and command against the repository.
  2. Remove stale statements discovered during the task.
  3. Confirm the document remains compact enough to be useful as a first-pass map.
  4. Include the context-file change in the same focused commit as the durable code change when appropriate.

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.