Dev Workflow Guide

01 — Daily Workflow

The Flow Every Developer Follows

1# Always start fresh from main
2git checkout main
3git pull origin main
4 
5# Create your branch
6git checkout -b feature/your-feature-name
7 
8# Stage & commit your work
9git add .
10git commit -m "feat: add user auth endpoint"
11 
12# Push & open a Pull Request
13git push origin feature/your-feature-name
14# Go to GitHub -> Open PR -> Request review -> Merge

02 — Branches

Branch Naming

F

feature/user-auth — new feature

B

fix/login-redirect — bug fix

H

hotfix/api-crash — urgent fix

E

experiment/new-model — ML / R&D

D

docs/update-readme — docs only

03 — Commits

Commit Convention

feat:new feature added

fix:bug or error fixed

docs:documentation only

refactor:code restructure, no behavior change

test:adding or fixing tests

chore:configs, deps, tooling

04 — Secrets & Environment

.env Rules — No Exceptions

❌ Never commit this

.env DATABASE_URL=postgres://real:pass@host/db SECRET_KEY=my-super-secret-123 API_KEY=sk-live-abc123xyz
# real credentials = instant security risk

✅ Always commit this

.env.example DATABASE_URL=your-database-url-here SECRET_KEY=your-secret-key-here API_KEY=your-api-key-here
# placeholder values only — safe to push

🔴 .env is in .gitignore — always. New dev? Run: cp .env.example .env then fill in your own values.