agentleFS
hemapriyan-rkhemapriyan-rk/claude-rigor-skills/skills/project-scaffolding/SKILL.md

project-scaffolding

Skill1 starsChanged 51 days agoMITView on GitHub

Set up a new project's directory structure and boilerplate following the real convention for its language/framework/deliverable type, rather than an invented ad hoc layout. Use whenever starting a new project or repo, adding a module that needs its own structural convention, or restructuring an existing messy layout. Covers single packages, applications, services, and monorepos.

  • Reads credentials

11 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use documentation-site and kubernetes.

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.
  • KMaruthi2002Skill

    documentation-site

    Plan, build and maintain a documentation website for a product, API, library, platform or internal system: information architecture (tutorials, how-to guides, reference, explanation), choosing a static site generator or hosted docs platform, navigation and search, versioning for multiple releases, generated API reference, code samples that are tested and actually run, docs-as-code workflow with review, previews, link checking and CI, plus accessibility, internationalisation and analytics. Use when someone asks to create a docs site, developer portal, knowledge base, handbook site, migrate docs to a new generator, add versioning or search to docs, or fix docs that users cannot navigate or that have drifted from the product.

    Also in 3 projects that use this

  • mjunaidcaSkill

    kubernetes

    Production-grade Kubernetes manifests and debugging for containerized applications. This skill should be used when users ask to deploy to Kubernetes, create K8s manifests, containerize for K8s, set up Deployments/Services/Jobs/StatefulSets/CronJobs, create namespaces with resource quotas, set up multi-team isolation, configure ResourceQuota/ LimitRange, secure with RBAC (ServiceAccount, Role, RoleBinding), configure init containers (model download, db wait, migrations), set up sidecars (logging, metrics), or debug pods (CrashLoopBackOff, logs, exec, describe, events). Auto-detects from Dockerfile/code, generates hardened manifests with educational comments. CKAD-aligned.

    Also in 3 projects that use this

The file

Files
SKILL.md

Project Scaffolding

A scaffold invented from habit instead of from the ecosystem's actual convention costs the project every time a new contributor or tool (a linter, a build system, a package registry) expects the structure it's used to and doesn't find it. This skill scaffolds to the real convention, and states which one it's following.

Step 1 — Identify the actual project type first

The correct scaffold depends on more than the language: a library has different needs than an application; a single service is structured differently from a monorepo; a CLI tool differs from a long-running service. Get this right before creating a single directory — the "generic" scaffold that ignores this distinction is wrong for most of the specific cases it gets applied to.

Step 2 — Follow the ecosystem's real convention, and say which one

Use the layout the language/framework's own tooling and community actually expect (for example: a Python package's expected src/ layout and packaging metadata file, a Node project's expected manifest and source/output separation, a Go module's expected command/internal package conventions, a framework's own CLI-generated structure where one exists). State explicitly which convention is being followed and why — presenting an idiosyncratic structure as if it's the standard one misleads anyone who later assumes it behaves like a familiar project of that type.

Step 3 — Separate concerns clearly

Source, tests, configuration, build output, and documentation each get their own place, not commingled. Make sure .gitignore matches — build/artifact directories excluded from version control (see github-master's guidance on not committing generated artifacts).

Step 4 — Minimum viable boilerplate, not maximum

Include what a project of this type actually needs immediately: a README stub, a license placeholder if the project needs one, a CI config skeleton if requested, and an example/template config file (.env.example, not a real .env with committed secrets) rather than committing actual configuration values. Don't create directories "for future use" that will sit empty for months — an empty placeholder folder adds noise to the structure without adding actual organization value; add it when there's real content for it, not before.

Step 5 — For a monorepo or multi-package layout, state the boundary explicitly

Name what's shared across packages versus what's private to one, and the convention for how packages depend on each other. This is the scaffolding decision that's hardest to change later, so it deserves being stated explicitly up front rather than left implicit in whatever the first two packages happened to do.

Step 6 — Restructuring an existing project is a migration, not a silent rewrite

State the plan (what moves where) before executing it. Move files with git mv rather than delete-and-recreate where possible, so version control tracks the change as a rename and the file's history follows it rather than appearing to start fresh (ties into github-master's commit-quality guidance on keeping history useful).

Output

State the project type identified, the convention being followed and why, the directory tree actually created, and which parts are functional immediately versus placeholders awaiting real content.

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.