New Git & GitHub Project Setup Checklist

Step-by-step checklist to initialize a repository, configure security, and set up CI/CD properly from day one.

Follow these steps when starting a project to ensure clean commit history, code quality, and branch protection.

Tick items as you go. Your progress is saved in this browser only.

1. Local Initialization

Initialize the Git repository Run `git init` in your root project directory.
Create a comprehensive .gitignore file Include language-specific build artifacts, OS files, and environment variables (.env).
Set up environment variable templates Create `.env.example` with dummy values for reference.
Configure code quality and formatting tools Add ESLint, Prettier, or relevant linters for your tech stack.
Make the initial commit Use a clear message such as 'chore: initial project structure'.

Create a new repository on GitHub Choose appropriate visibility (public or private).
Link the local repository to GitHub remote Run `git remote add origin <URL>`.
Rename default branch to main Run `git branch -M main` if not already default.
Push initial commit to remote Run `git push -u origin main`.
Add a detailed README.md file Include installation instructions, prerequisites, and usage guides.

Add an open-source license file Choose MIT, Apache 2.0, or suitable license if public.
Enable secret scanning and Dependabot alerts Turn on automated vulnerability and credential leak detection in repo settings.
Set up branch protection rules for main Require pull request reviews and status checks before merging.
Add issue and pull request templates Place templates inside the `.github/` directory.
Configure repository secrets for deployments Store API keys and access tokens securely in GitHub Actions Secrets.

Create a GitHub Actions workflow for testing Configure automated test runs on every pull request.
Set up automated linting and formatting checks Ensure code adheres to standards before merging.
Configure deployment pipelines Automate staging and production deployments on merge.
Verify workflow execution Trigger a test PR to confirm pipeline passes cleanly.
Document contribution guidelines Add a `CONTRIBUTING.md` file for team members or external contributors.

Confirm no sensitive data was committed Verify git history is free of passwords, tokens, or private keys.
Invite team members with appropriate roles Grant Write, Admin, or Read access based on responsibility.
Clone the repo to a fresh directory to test setup Ensure setup instructions in README work out of the box.
Tag the first release or milestone Use semantic versioning (e.g., v0.1.0).
Archive setup notes and clean up temporary branches Keep remote repository tidy from day one.