Back to Details

project-bootstrapper

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Project Bootstrapper

项目初始化工具

Sets up new projects or improves existing projects with development best practices, tooling, documentation, and workflow automation.
使用开发最佳实践、工具、文档和工作流自动化来搭建新项目或优化现有项目。

When to Use

适用场景

  • "set up a new project"
  • "bootstrap this project"
  • "add best practices"
  • "improve project structure"
  • "set up development tooling"
  • "initialize project properly"
  • "搭建新项目"
  • "初始化此项目"
  • "添加最佳实践"
  • "优化项目结构"
  • "配置开发工具"
  • "正确初始化项目"

What It Sets Up

可配置内容

1. Project Structure

1. 项目结构

  • Standard directories (src/, tests/, docs/, scripts/, .github/)
  • Logical file organization
  • Structure improvements
  • 标准目录（src/、tests/、docs/、scripts/、.github/）
  • 合理的文件组织方式
  • 结构优化

2. Git Configuration

2. Git配置

  • Comprehensive 
    .gitignore
  • .gitattributes
    for line endings/diffs
  • Git hooks (pre-commit, commit-msg)
  • Branch protection patterns
  • Git LFS if needed
  • 完善的 
    .gitignore
    文件
  • 用于行尾处理/差异对比的 
    .gitattributes
  • Git钩子（pre-commit、commit-msg）
  • 分支保护规则
  • 按需配置Git LFS

3. Documentation

3. 文档

  • Comprehensive 
    README.md
  • CONTRIBUTING.md
  • Code documentation (JSDoc, docstrings)
  • CHANGELOG.md
    structure
  • Architecture docs if complex
  • 完善的 
    README.md
  • CONTRIBUTING.md
  • 代码文档（JSDoc、docstrings）
  • CHANGELOG.md
    结构
  • 复杂项目的架构文档

4. Testing Setup

4. 测试配置

  • Identify/suggest testing framework
  • Test structure and conventions
  • Example/template tests
  • Configure test runners
  • Coverage reporting
  • Testing scripts/commands
  • 识别/推荐测试框架
  • 测试结构与规范
  • 测试示例/模板
  • 配置测试运行器
  • 覆盖率报告
  • 测试脚本/命令

5. Code Quality Tools

5. 代码质量工具

  • Linters (ESLint, Pylint, etc.)
  • Formatters (Prettier, Black, etc.)
  • Type checking (TypeScript, mypy, etc.)
  • Pre-commit hooks for quality
  • Editor configs (.editorconfig)
  • Code quality badges
  • 代码检查工具（ESLint、Pylint等）
  • 代码格式化工具（Prettier、Black等）
  • 类型检查（TypeScript、mypy等）
  • 用于质量管控的提交前钩子
  • 编辑器配置文件（.editorconfig）
  • 代码质量徽章

6. Dependencies Management

6. 依赖管理

  • Package manager configuration
  • Organize dependencies
  • Check security vulnerabilities
  • Set up dependency updates (Dependabot, Renovate)
  • Create lock files
  • Document dependency choices
  • 包管理器配置
  • 依赖整理
  • 安全漏洞检查
  • 配置依赖更新（Dependabot、Renovate）
  • 生成锁文件
  • 记录依赖选择依据

7. Development Workflow

7. 开发工作流

  • Useful npm scripts / Makefile targets
  • Environment variable templates (.env.example)
  • Docker configuration if appropriate
  • Development startup scripts
  • Hot-reload / watch modes
  • Document development workflow
  • 实用的npm脚本 / Makefile目标
  • 环境变量模板（.env.example）
  • 按需配置Docker
  • 开发启动脚本
  • 热重载/监听模式
  • 开发工作流文档

8. CI/CD Setup

8. CI/CD配置

  • GitHub Actions / GitLab CI config
  • Automated testing
  • Automated deployment (if applicable)
  • Status badges
  • Release automation
  • Branch protection
  • GitHub Actions / GitLab CI配置
  • 自动化测试
  • 自动化部署（如适用）
  • 状态徽章
  • 发布自动化
  • 分支保护

Approach

实施流程

Discovery Phase

需求调研阶段

Ask clarifying questions:
  1. Project type: New or existing?
  2. Primary purpose: Web app, library, CLI tool?
  3. Language/framework: JS/TS, Python, Go, etc.?
  4. Collaboration: Personal or team?
  5. Deployment target: Server, cloud, mobile, desktop?
  6. Preferences: Specific tools/frameworks?
  7. Scope: Full setup or specific areas?
提出明确问题：
  1. 项目类型：新项目还是现有项目？
  2. 核心用途：Web应用、库、CLI工具？
  3. 语言/框架：JS/TS、Python、Go等？
  4. 协作模式：个人项目还是团队项目？
  5. 部署目标：服务器、云、移动端、桌面端？
  6. 偏好选择：特定工具/框架？
  7. 范围：完整配置还是特定领域？

Implementation Phase

执行阶段

  1. Analyze existing structure (if existing project)
  2. Create plan based on answers
  3. Show plan and get approval
  4. Implement systematically (one area at a time)
  5. Verify completeness
  6. Provide handoff documentation
  1. 分析现有结构（针对现有项目）
  2. 基于调研结果制定方案
  3. 展示方案并获取确认
  4. 系统实施（分领域逐步完成）
  5. 验证完整性
  6. 交付文档

Customization

自定义适配

Adapts to:
  • Language ecosystem: Node.js vs Python vs Go vs Rust
  • Project size: Small script vs large app
  • Team size: Solo vs collaborative
  • Maturity: Startup speed vs enterprise standards
可适配以下场景：
  • 语言生态：Node.js、Python、Go、Rust等
  • 项目规模：小型脚本到大型应用
  • 团队规模：独立开发到团队协作
  • 成熟度：快速启动到企业级标准

Tools Used

使用的工具

  • AskUserQuestion: Gather requirements
  • Write: Create configuration files, documentation
  • Edit: Update existing files
  • Bash: Initialize tools (git init, npm init)
  • Read: Analyze existing structure
  • Glob: Find files to update
  • AskUserQuestion：收集需求
  • Write：创建配置文件、文档
  • Edit：更新现有文件
  • Bash：初始化工具（git init、npm init）
  • Read：分析现有结构
  • Glob：查找待更新文件

Success Criteria

成功标准

  • All standard files present and configured
  • Clear and complete documentation
  • Documented development workflow
  • Automated quality tooling (pre-commit hooks)
  • Easy test execution
  • Follows language/framework conventions
  • Quick developer onboarding
  • No obvious best practices missing
  • 所有标准文件已配置完成
  • 文档清晰完整
  • 开发工作流已文档化
  • 自动化质量管控工具（提交前钩子）已配置
  • 测试执行便捷
  • 遵循语言/框架规范
  • 开发者快速上手
  • 无明显缺失的最佳实践

Templates

模板

  • Node.js/TypeScript web app
  • Python CLI tool
  • Python web API (FastAPI/Flask)
  • React/Next.js app
  • Go service
  • Rust CLI/library
  • Node.js/TypeScript Web应用
  • Python CLI工具
  • Python Web API（FastAPI/Flask）
  • React/Next.js应用
  • Go服务
  • Rust CLI/库

Integration

集成

  • feature-planning: For planning custom features
  • code-auditor: For validating setup quality
  • codebase-documenter: For generating detailed docs
  • feature-planning：用于规划自定义功能
  • code-auditor：用于验证配置质量
  • codebase-documenter：用于生成详细文档

Scope Control

范围控制

  • Full bootstrap: Everything from scratch
  • Partial setup: Specific areas only (e.g., "just add testing")
  • Improvement pass: Enhance existing project
  • Audit + fix: Check what's missing and add it
  • 完整初始化：从零搭建所有内容
  • 部分配置：仅针对特定领域（如“仅添加测试配置”）
  • 优化升级：增强现有项目
  • 审计修复：检查缺失内容并补充