Sign in to create and edit playbooks. Sign In Register

Initialize Repository

BSP-2 Order: #2 Elaboration Has Dependencies

Updated 4 months ago

Guidance

Initialize Repository

Objective

Create a new Git repository with essential root-level files: .gitignore, README.md, LICENSE, and initial commit.


Process

1. Initialize Git

git init
git branch -M main

2. Create .gitignore

Generate a .gitignore tailored to the technology stack from SAO.md. Include patterns for:

# Python
__pycache__/
*.py[cod]
*$py.class
*.egg-info/
dist/
build/
.venv/
venv/
*.egg

# Node.js
node_modules/
npm-debug.log*

# IDE
.vscode/
.idea/
*.swp
*.swo
*~

# OS
.DS_Store
Thumbs.db

# Environment
.env
.env.local
.env.*.local

# Database
*.sqlite3
db.sqlite3

# Logs
logs/
*.log

# Coverage
htmlcov/
.coverage
.coverage.*
coverage.xml

# Build artifacts
staticfiles/
media/

Adapt based on actual stack decisions in SAO.md.

3. Create README.md

# {Project Name}

{One-sentence description from ESM user journey}

## Quick Start

\`\`\`bash
make provision   # Install prerequisites & dependencies
make run         # Start development server
\`\`\`

Then open http://localhost:8000 in your browser.

## Development

| Command          | Description                    |
|------------------|--------------------------------|
| `make provision` | Install all prerequisites      |
| `make run`       | Start development server       |
| `make test`      | Run all tests                  |
| `make lint`      | Run linter                     |
| `make format`    | Auto-format code               |
| `make clean`     | Remove build artifacts         |
| `make help`      | Show all available targets     |

## Documentation

- [System Architecture Overview](docs/architecture/SAO.md)
- [Modus Operandi](docs/process/MODUS_OPERANDI.md)

4. Create LICENSE

Choose license based on project requirements. Default to MIT unless SAO.md specifies otherwise.

5. Initial Commit

git add .
git commit -m "chore(init): initialize repository with .gitignore, README, LICENSE"

Deliverables

  • Git repository initialized on main branch
  • .gitignore created for project stack
  • README.md with Quick Start and Makefile target table
  • LICENSE file created
  • Initial commit made

Inputs

Read these before starting this activity. They are produced earlier in the playbook and are authoritative — raise a drift event instead of deviating.

  • Makefile Template (Code, Required) — produced by Create Makefile (#93).
Details
Order:
#2
Phase:
Predecessor:
BSP-6 Create Makefile
Created:
Apr 12, 2026
Last Updated:
May 21, 2026
Workflow
Bootstrap Project

Bootstrap a greenfield project from SAO.md decisions. Install prerequisites, initialize repository, scaffold structure, configure tooling, create Makefile, verify with a …

View Workflow
Assigned Agent

No agent assigned

Required Skills

No skills linked

Rules

No rules linked.

Input Artifacts 1
Output Artifacts

No output artifacts