project-checklist

Generate a project-checklist.md template covering setup, tests, lint, typecheck, README, and permissions.

Updated May 4, 2026
One-click install
npx skills add https://github.com/panamini/pi-tooling --skill project-checklist-panamini
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-checklist
Source: https://github.com/panamini/pi-tooling/tree/main/skills/project-checklist
Command: npx skills add https://github.com/panamini/pi-tooling --skill project-checklist-panamini

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

It solves the problem of missing setup, validation, and cleanup steps when starting a new project or making significant changes.

Core Features & Use Cases

  • Lightweight onboarding checklist creation: Produces a consistent project-checklist.md template in the project root.
  • Pre-work consistency pass: Guides you to confirm project root, dependencies, run tests/lint/typecheck, review README instructions, and validate permissions/env requirements.
  • Workflow timing fit: Works well at branch start, before reviews/PRs, and ahead of long refactors.

Quick Start

Run the checklist generator script in your project root, so it writes project-checklist.md for you to fill in before you touch code.

Frequently Asked Questions about project-checklist

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What is a project onboarding checklist and when do I need one?

A project onboarding checklist is a validation template for setup and cleanup steps. You need one when starting new feature branches, preparing for PR reviews, or managing long refactors to ensure consistent checks.

How do I create a pre-flight validation checklist for my repository?

Generate a pre-flight validation checklist by running a script in your project root to write `project-checklist.md`. This template guides you to confirm dependencies, run tests/lint/typecheck, and validate permissions before coding.

Does this checklist generator require any dependencies to run?

This checklist generator requires no external dependencies. It operates as a standalone script to produce the `project-checklist.md` template directly in your project root.

What's the best way to ensure repo hygiene before a PR review?

The best way to ensure repo hygiene before a PR is using a pre-flight checklist covering README verification, test execution, linting, typechecking, and environment validation to prevent skipped validation steps.

What steps should a refactoring checklist cover for long-term projects?

A refactoring checklist should cover project root confirmation, dependency setup, test/lint/typecheck runs, README instruction verification, and permissions/env validation to maintain consistent checks throughout the refactor.