agentleFS
tejastn10tejastn10/workbench/skills/design/scaffold-project/SKILL.md

scaffold-project

Skill1 starsChanged 2 months agoMITView on GitHub

Bootstrap a new repo or service the way Tejas's existing repos are set up — pick the closest existing template, then apply the standard baseline (house-style README, MIT LICENSE.md, commitlint conventional config, husky commit-msg/pre-commit/pre-push hooks, security-audit workflow, issue/PR templates, .nvmrc / .python-version / go.mod). Use when asked to "start a new service", "scaffold a repo", "set up a new project", or "bootstrap X".

  • Reads credentials

11 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 11 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    If nothing is close, copy the nearest and note the divergence.

    line 23

“Common” is measured: kept by at least 6 in 10 of the 11 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

Scaffold a new project

Tejas has starter templates already. Reuse one — don't hand-roll a new setup.

Pick the base template

New thingCopy fromStack baseline
NestJS backend servicehearth / emberNest, versioned modules, Biome, docker-compose
React SPAedenVite, React 19, TS, Biome, axios helper layer
Next.js apparbor / nimbusNext App Router, Tailwind v4, shadcn, Biome
Go CLIhalcyon / quillcobra, cmd/, tasks/, utils/, install.sh
Go service (queue / HTTP)argusDockerfile multi-stage, docker-image workflow
Python service (FastAPI)papyrus backendPoetry, flake8/black/isort, pytest
Python script / botvervePoetry, src/ layout, schedule
Turborepo monorepoverdantTurborepo + Nest + Vite

If nothing is close, copy the nearest and note the divergence.

Standard baseline — every repo gets these

  • README.md — house style (copy the skeleton from any recent repo): centered logo.svg block, # Name <emoji>, badge row, bold intro + tagline, --- dividers, ## Features 🌟 / ## Getting Started 🚀 / ## Structure 📂 / ## License 📜 / ## Acknowledgments 🙌.
  • LICENSE.md — MIT, Copyright (c) <year> Tejas Nikhar.
  • .commitlintrc.yml — extends: ["@commitlint/config-conventional"].
  • .husky/ — commit-msg (commitlint), pre-commit (lint / lint-staged), pre-push (branch name must match ^(feature|bugfix|improvement)/.+, main allowed).
  • .github/workflows/security-audit.yml — per stack: npm audit --audit-level=low (JS), gosec + govulncheck (Go), safety (Python). PR-triggered with types: [edited, opened, synchronize].
  • .github/workflows/{lint,unit-test}.yml where the stack has them (Go: golangci-lint pinned + go test ./... -v; JS: biome check; Python: poetry run pytest).
  • .github/ISSUE_TEMPLATE/{bug_report,feature_request}.md and .github/pull_request_template.md.
  • .gitignore — macOS + the stack's noise.
  • Version pin file: .nvmrc (Node ≥ 22), .python-version, or Go version in go.mod (workflows use go-version-file: go.mod).
  • biome.json for any TS/JS repo (tab indent, width 100, double quotes, es5 trailing commas, useImportType/useExportType error, noUnusedVariables error).
  • Dockerfile (multi-stage, non-root runtime, manifest copied before source) and docker-compose.yml for local infra where the service needs it.

Process

  1. Confirm stack + name with the user if not given. Names are short, single words (their repos: halcyon, ember, arbor…). Ask for the emoji + one-line description.
  2. Copy the base template's config files; strip its domain code.
  3. Apply the baseline checklist above; fill README from the house skeleton.
  4. First commit: chore: initialize project (or feat: initialize <name>) as the configured git user — never co-author.
  5. Branch convention: feature/<name>, bugfix/<name>, improvement/<name>.

Anti-patterns

  • ❌ Writing a fresh tool/lint/CI setup when a template already encodes it.
  • ❌ A README that isn't the house style.
  • ❌ Skipping the husky hooks or commitlint config.
  • ❌ Committing .env with real values (placeholders only, and say so).

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.