agentleFS
jordanhubbardjordanhubbard/nanolang/.cursor/rules/file-organization/RULE.md

nanolang / file-organization

Cursor rule628 starsChanged 4 months agoApache-2.0View on GitHub

Enforces proper file organization for planning documentation - all planning .md files must go in planning/ directory

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

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

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

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

    CRITICAL RULE: All planning-related markdown files MUST be created in the planning/ directory, never at the top level.

    line 8

≈ “Common” is an estimate: at least 1 in 5 of the 6,350 Cursor rule 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
RULE.md

File Organization Rules

CRITICAL RULE: All planning-related markdown files MUST be created in the planning/ directory, never at the top level.

Allowed Top-Level Files ONLY:

  • README.md
  • CONTRIBUTING.md
  • CONTRIBUTORS.md
  • LICENSE
  • MEMORY.md
  • SPEC_AUDIT.md

Files That Belong in planning/:

  • Design documents (e.g., GC_DESIGN.md, GENERICS_DESIGN.md)
  • Implementation plans (e.g., IMPLEMENTATION_ROADMAP.md)
  • Status reports (e.g., SELF_HOST_STATUS.md, PHASE2_COMPLETE.md)
  • Roadmaps and strategies (e.g., BOOTSTRAP_STRATEGY.md)
  • Architecture decisions
  • Project audits and assessments
  • TODO lists and task tracking
  • Any other planning or project management documentation

Enforcement Mechanisms:

  1. AI Level: This rule + Factory droid (nanolang-planning-directory-enforcer)
  2. Git Level: Pre-commit hook (see scripts/pre-commit-planning-enforcer)

Rationale:

Keeps the repository root clean and navigable by segregating project documentation from essential top-level files.


For complete details, see: @.factory/PROJECT_RULES.md

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.