mcpField
P
project-setup

project-setup

github.com/ratacatDevelopment5846 installsUpdated 37w ago
Repository

About project-setup

A project setup skill that guides teams through configuring typing, linting, formatting, tests, pre-commit checks, and CI. It provides language references for Python and TypeScript and recommends incremental migrations for existing projects.

Key features

  1. 01Setup guidance by language
  2. 02Typing, linting, and formatting sequence
  3. 03Testing and pre-commit practices
  4. 04CI and quality checklist
  5. 05Incremental migration guidance

Use cases

  1. 01Set up a new software project
  2. 02Standardize Python or TypeScript checks
  3. 03Add tests and pre-commit hooks
  4. 04Improve an existing project's checks incrementally

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/ratacat/claude-skills --skill project-setup

After installing, type/project-setupin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

reference/
common-patterns.md
python.md
typescript.md

Details

From the project README

Project Setup

Core Principles

  • Strong Typing: Strict mode enabled; types catch bugs at compile time
  • Strong Linting: Strict rules by default; easier to disable than add later
  • Auto Formatting: Automated and consistent; no manual formatting
  • Checks at Every Stage: Pre-commit hooks + CI; catch issues early
  • Co-located Tests: foo.ts → foo.test.ts; obvious what's tested
  • Behavior-Focused: Test what code does, not how; mock only external boundaries

Workflow

  1. Check reference/ for language guide (Python, TypeScript)
  2. If no guide: WebSearch "[language] project setup best practices"
  3. Follow setup: typing → linting → formatting → testing → pre-commit → CI
  4. For existing projects: migrate incrementally in same order

Reference Files

  • reference/python.md - uv, ruff, basedpyright, pytest
  • reference/typescript.md - pnpm, ESLint, Prettier, Vitest
  • reference/common-patterns.md - Testing philosophy, CI patterns, security

Tool Selection

Prefer tools that are: ecosystem standard, actively maintained, strict by default, fast, well-integrated (editor + CI + pre-commit).

Quality Checklist

  • Typing: Strictest mode, no any without justification
  • Linting: Strict rules, warnings as errors
  • Formatting: Auto-format on save + pre-commit
  • Testing: Co-located tests, coverage >80%
  • Pre-commit: Format, lint, type-check
  • CI: Same checks + coverage reporting
  • README: Setup instructions
  • All checks pass on initial commit

Comments

Markdown supported