python-MIT-repo-template/docs/NEW_PROJECT_CHECKLIST.md

New Project Checklist

Work through this checklist when setting up a new project from this template. It's ordered roughly in the sequence you'd actually do the work, but feel free to skip items that don't apply and add project-specific ones at the bottom.

1. Repository setup

• Create the repository from this template
• Rename the project (repo name, main.py header, README title)
• Update LICENCE copyright holder and year
• Review .gitignore for anything project-specific to add (env files, build artefacts, data dumps)
• Set repository visibility (public/private) and default branch protections
• Add collaborators / team access
• Update README badges (or remove the ones that don't apply)
• Enable the wiki and publish the wiki template pages

2. Define the project

• Create the Value Stream Map — current state at minimum, future state if the target process is already known
• Open the "Define value stream goals" issue (from the issue templates) and fill it in
• Open the "Write project specification" issue and complete the project specification template
• Get the specification reviewed and approved by stakeholders
• Identify and record non-goals explicitly — don't skip this

3. Planning

• Break the specification down into milestones
• Create the standard setup issues (see .github/ISSUE_TEMPLATE/) in the issue tracker
• Set up a project board / backlog and add the initial issues to it
• Agree on a definition of "done" for issues and for the project as a whole
• Identify risks and mitigations (Section 12 of the specification)

4. Environment & tooling

• Choose and pin the Python version (.python-version / pyproject.toml)
• Set up the virtual environment / dependency manager
• Add linting and formatting tools and their configuration
• Add a test framework and a first smoke test
• Set up CI (lint, test, build) on push/PR
• Configure branch protection to require CI + review before merge

5. Documentation

• Fill in the README with an actual project description, setup, and usage instructions
• Link the project specification and value stream map from the README
• Set up the wiki structure (see wiki/) with at least a Home page and a Getting Started page
• Document how to run, test, and deploy the project

6. Kickoff

• Walk stakeholders through the approved specification and value stream map
• Confirm milestones and timeline with everyone involved
• Close out the setup issues once each is genuinely complete — don't just close them to clear the board
• Schedule the first review checkpoint (e.g. after MVP / first milestone)

Project-specific additions