AgentSkillsCN

Project Scaffolding

项目搭建

SKILL.md
--- frontmatter
applyTo: "**/*scaffold*,**/*init*,**/*new*,**/*create*,**/README*"

Project Scaffolding Skill

First impressions matter. Set projects up for success.

Essential Files

FilePurpose
README.mdHero banner + overview + quick start
CONTRIBUTING.mdHow to contribute
LICENSE.mdLegal terms
CHANGELOG.mdVersion history
.gitignoreIgnored files
.editorconfigConsistent formatting

README Structure

markdown
<!-- Hero SVG banner -->
# Project Name

> One-line description

## Features
- Feature 1
- Feature 2

## Quick Start
[3 commands max]

## Documentation
[Links]

## License
[Badge + link]

Hero Banner Pattern

  • •Width: 800-1200px
  • •Height: 200-400px
  • •Include: Logo, tagline, 3-5 key features
  • •Format: SVG (scalable), PNG fallback
  • •Dark/light mode variants

Documentation Folder

text
docs/
├── README.md           # Index
├── QUICK-START.md      # 5-min guide
├── ARCHITECTURE.md     # System design
├── API.md              # Reference
└── CONTRIBUTING.md     # Dev guide

Planning Files

FileWhen
ROADMAP.mdMulti-phase projects
TODO.mdSimple task tracking
DECISIONS.mdArchitecture decisions
RISKS.mdKnown risks

Config Files by Stack

StackEssential Configs
Node.jspackage.json, tsconfig.json, .nvmrc
Pythonpyproject.toml, requirements.txt
VS Code.vscode/settings.json, launch.json
GitHub.github/workflows/, CODEOWNERS

Quality Gates

  • • README has hero banner
  • • Quick start works in < 5 min
  • • License specified
  • • Contributing guide exists
  • • .gitignore appropriate for stack

Synapses

See synapses.json for connections.