Pre-Push Codebase Audit
Selective Reading Rule
Start with:
references/senior-master-standard.md
references/usage-routing.md
references/quality-checklist.md
Then load only the inherited docs, scripts, assets, or examples that match the user's actual task.
As a senior engineer, you're doing the final review before pushing this code to GitHub. Check everything carefully and fix problems as you find them.
When to Use This Skill
- User requests "audit the codebase" or "review before push"
- Before making the first push to GitHub
- Before making a repository public
- Pre-production deployment review
- User asks to "clean up the code" or "optimize everything"
Your Job
Review the entire codebase file by file. Read the code carefully. Fix issues right away. Don't just note problems—make the necessary changes.
Audit Process
1. Clean Up Junk Files
Start by looking for files that shouldn't be on GitHub:
Delete these immediately:
- OS files:
.DS_Store, Thumbs.db, desktop.ini
- Logs:
*.log, npm-debug.log*, yarn-error.log*
- Temp files:
*.tmp, *.temp, *.cache, *.swp
- Build output:
dist/, build/, .next/, out/, .cache/
- Dependencies:
node_modules/, vendor/, __pycache__/, *.pyc
- IDE files:
.idea/, .vscode/ (ask user first), *.iml, .project
- Backup files:
*.bak, *_old.*, *_backup.*, *_copy.*
- Test artifacts:
coverage/, .nyc_output/, test-results/
- Personal junk:
TODO.txt, NOTES.txt, scratch.*, test123.*
Critical - Check for secrets:
.env files (should never be committed)
- Files containing:
password, api_key, token, secret, private_key
*.pem, *.key, *.cert, credentials.json, serviceAccountKey.json
If you find secrets in the code, mark it as a CRITICAL BLOCKER.
2. Fix .gitignore
Check if the .gitignore file exists and is thorough. If it’s missing or not complete, update it to include all junk file patterns above. Ensure that .env.example exists with keys but no values.
3. Audit Every Source File
Look through each code file and check:
Dead Code (remove immediately):
- Commented-out code blocks
- Unused imports/requires
- Unused variables (declared but never used)
- Unused functions (defined but never called)
- Unreachable code (after
return, inside if (false))
- Duplicate logic (same code in multiple places—combine)
Code Quality (fix issues as you go):
- Vague names:
data, info, temp, thing → rename to be descriptive
- Magic numbers:
if (status === 3) → extract to named constant
- Debug statements: remove
console.log, print(), debugger
- TODO/FIXME comments: either resolve them or delete them
- TypeScript
any: add proper types or explain why any is used
- Use
=== instead of == in JavaScript
- Functions longer than 50 lines: consider splitting
- Nested code greater than 3 levels: refactor with early returns
Logic Issues (critical):
- Missing null/undefined checks
- Array operations on potentially empty arrays
- Async functions that are not awaited
- Promises without
.catch() or try/catch
- Possibilities for infinite loops
- Missing
default in switch statements
4. Security Check (Zero Tolerance)
Secrets: Search for hardcoded passwords, API keys, and tokens. They must be in environment variables.
Injection vulnerabilities:
- SQL: No string concatenation in queries—use parameterized queries only
- Command injection: No
exec() with user-provided input
- Path traversal: No file paths from user input without validation
- XSS: No
innerHTML or dangerouslySetInnerHTML with user data
Auth/Authorization:
- Passwords hashed with bcrypt/argon2 (never MD5 or plain text)
- Protected routes check for authentication
- Authorization checks on the server side, not just in the UI
- No IDOR: verify users own the resources they are accessing
Data exposure:
- API responses do not leak unnecessary information
- Error messages do not expose stack traces or database details
- Pagination is present on list endpoints
Dependencies:
- Run
npm audit or an equivalent tool
- Flag critically outdated or vulnerable packages
5. Scalability Check
Database:
- N+1 queries: loops with database calls inside → use JOINs or batch queries
- Missing indexes on WHERE/ORDER BY columns
- Unbounded queries: add LIMIT or pagination
- Avoid
SELECT *: specify columns
API Design:
- Heavy operations (like email, reports, file processing) → move to a background queue
- Rate limiting on public endpoints
- Caching for data that is read frequently
- Timeouts on external calls
Code:
- No global mutable state
- Clean up event listeners (to avoid memory leaks)
- Stream large files instead of loading them into memory
6. Architecture Check
Organization:
- Clear folder structure
- Files are in logical locations
- No "misc" or "stuff" folders
Separation of concerns:
- UI layer: only responsible for rendering
- Business logic: pure functions
- Data layer: isolated database queries
- No 500+ line "god files"
Reusability:
- Duplicate code → extract to shared utilities
- Constants defined once and imported
- Types/interfaces reused, not redefined
7. Performance
Backend:
- Expensive operations do not block requests
- Batch database calls when possible
- Set cache headers correctly
Frontend (if applicable):
- Implement code splitting
- Optimize images
- Avoid massive dependencies for small utilities
- Use lazy loading for heavy components
8. Documentation
README.md must include:
- Description of what the project does
- Instructions for installation and execution
- Required environment variables
- Guidance on running tests
Code comments:
- Explain WHY, not WHAT
- Provide explanations for complex logic
- Avoid comments that merely repeat the code
9. Testing
- Critical paths should have tests (auth, payments, core features)
- No
test.only or fdescribe should remain in the code
- Avoid
test.skip without an explanation
- Tests should verify behavior, not implementation details
10. Final Verification
After making all changes, run the app. Ensure nothing is broken. Check that:
- The app starts without errors
- Main features work
- Tests pass (if they exist)
- No regressions have been introduced
Output Format
After auditing, provide a report:
CODEBASE AUDIT COMPLETE
FILES REMOVED:
- node_modules/ (build artifact)
- .env (contained secrets)
- old_backup.js (unused duplicate)
CODE CHANGES:
[src/api/users.js]
✂ Removed unused import: lodash
✂ Removed dead function: formatOldWay()
🔧 Renamed 'data' → 'userData' for clarity
🛡 Added try/catch around API call (line 47)
[src/db/queries.js]
⚡ Fixed N+1 query: now uses JOIN instead of loop
SECURITY ISSUES:
🚨 CRITICAL: Hardcoded API key in config.js (line 12) → moved to .env
⚠️ HIGH: SQL injection risk in search.js (line 34) → fixed with parameterized query
SCALABILITY:
⚡ Added pagination to /api/users endpoint
⚡ Added index on users.email column
FINAL STATUS:
✅ CLEAN - Ready to push to GitHub
Scores:
Security: 9/10 (one minor header missing)
Code Quality: 10/10
Scalability: 9/10
Overall: 9/10
Key Principles
- Read the code thoroughly, don't skim
- Fix issues immediately, don’t just document them
- If uncertain about removing something, ask the user
- Test after making changes
- Be thorough but practical—focus on real problems
- Security issues are blockers—nothing should ship with critical vulnerabilities
Related Skills
@security-auditor - Deeper security review
@systematic-debugging - Investigate specific issues
@git-pushing - Push code after audit
Limitations
- Use this skill only when the task clearly matches the scope described above.
- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.
1---2name: codebase-audit-pre-push3description: ALWAYS use this when the request matches Codebase Audit PRE Push: Deep audit before GitHub push: removes junk files, dead code, security holes, and optimization issues.4---56# Pre-Push Codebase Audit78## Selective Reading Rule910Start with:1112- `references/senior-master-standard.md`13- `references/usage-routing.md`14- `references/quality-checklist.md`1516Then load only the inherited docs, scripts, assets, or examples that match the user's actual task.1718As a senior engineer, you're doing the final review before pushing this code to GitHub. Check everything carefully and fix problems as you find them. 1920## When to Use This Skill 2122- User requests "audit the codebase" or "review before push" 23- Before making the first push to GitHub 24- Before making a repository public 25- Pre-production deployment review 26- User asks to "clean up the code" or "optimize everything" 2728## Your Job 2930Review the entire codebase file by file. Read the code carefully. Fix issues right away. Don't just note problems—make the necessary changes. 3132## Audit Process 3334### 1. Clean Up Junk Files 3536Start by looking for files that shouldn't be on GitHub: 3738**Delete these immediately:** 39- OS files: `.DS_Store`, `Thumbs.db`, `desktop.ini` 40- Logs: `*.log`, `npm-debug.log*`, `yarn-error.log*` 41- Temp files: `*.tmp`, `*.temp`, `*.cache`, `*.swp` 42- Build output: `dist/`, `build/`, `.next/`, `out/`, `.cache/` 43- Dependencies: `node_modules/`, `vendor/`, `__pycache__/`, `*.pyc` 44- IDE files: `.idea/`, `.vscode/` (ask user first), `*.iml`, `.project` 45- Backup files: `*.bak`, `*_old.*`, `*_backup.*`, `*_copy.*` 46- Test artifacts: `coverage/`, `.nyc_output/`, `test-results/` 47- Personal junk: `TODO.txt`, `NOTES.txt`, `scratch.*`, `test123.*` 4849**Critical - Check for secrets:** 50- `.env` files (should never be committed) 51- Files containing: `password`, `api_key`, `token`, `secret`, `private_key` 52- `*.pem`, `*.key`, `*.cert`, `credentials.json`, `serviceAccountKey.json` 5354If you find secrets in the code, mark it as a CRITICAL BLOCKER. 5556### 2. Fix .gitignore 5758Check if the `.gitignore` file exists and is thorough. If it’s missing or not complete, update it to include all junk file patterns above. Ensure that `.env.example` exists with keys but no values. 5960### 3. Audit Every Source File 6162Look through each code file and check: 6364**Dead Code (remove immediately):** 65- Commented-out code blocks 66- Unused imports/requires 67- Unused variables (declared but never used) 68- Unused functions (defined but never called) 69- Unreachable code (after `return`, inside `if (false)`) 70- Duplicate logic (same code in multiple places—combine) 7172**Code Quality (fix issues as you go):** 73- Vague names: `data`, `info`, `temp`, `thing` → rename to be descriptive 74- Magic numbers: `if (status === 3)` → extract to named constant 75- Debug statements: remove `console.log`, `print()`, `debugger` 76- TODO/FIXME comments: either resolve them or delete them 77- TypeScript `any`: add proper types or explain why `any` is used 78- Use `===` instead of `==` in JavaScript 79- Functions longer than 50 lines: consider splitting 80- Nested code greater than 3 levels: refactor with early returns 8182**Logic Issues (critical):** 83- Missing null/undefined checks 84- Array operations on potentially empty arrays 85- Async functions that are not awaited 86- Promises without `.catch()` or try/catch 87- Possibilities for infinite loops 88- Missing `default` in switch statements 8990### 4. Security Check (Zero Tolerance) 9192**Secrets:** Search for hardcoded passwords, API keys, and tokens. They must be in environment variables. 9394**Injection vulnerabilities:** 95- SQL: No string concatenation in queries—use parameterized queries only 96- Command injection: No `exec()` with user-provided input 97- Path traversal: No file paths from user input without validation 98- XSS: No `innerHTML` or `dangerouslySetInnerHTML` with user data 99100**Auth/Authorization:** 101- Passwords hashed with bcrypt/argon2 (never MD5 or plain text) 102- Protected routes check for authentication 103- Authorization checks on the server side, not just in the UI 104- No IDOR: verify users own the resources they are accessing 105106**Data exposure:** 107- API responses do not leak unnecessary information 108- Error messages do not expose stack traces or database details 109- Pagination is present on list endpoints 110111**Dependencies:** 112- Run `npm audit` or an equivalent tool 113- Flag critically outdated or vulnerable packages 114115### 5. Scalability Check 116117**Database:** 118- N+1 queries: loops with database calls inside → use JOINs or batch queries 119- Missing indexes on WHERE/ORDER BY columns 120- Unbounded queries: add LIMIT or pagination 121- Avoid `SELECT *`: specify columns 122123**API Design:** 124- Heavy operations (like email, reports, file processing) → move to a background queue 125- Rate limiting on public endpoints 126- Caching for data that is read frequently 127- Timeouts on external calls 128129**Code:** 130- No global mutable state 131- Clean up event listeners (to avoid memory leaks) 132- Stream large files instead of loading them into memory 133134### 6. Architecture Check 135136**Organization:** 137- Clear folder structure 138- Files are in logical locations 139- No "misc" or "stuff" folders 140141**Separation of concerns:** 142- UI layer: only responsible for rendering 143- Business logic: pure functions 144- Data layer: isolated database queries 145- No 500+ line "god files" 146147**Reusability:** 148- Duplicate code → extract to shared utilities 149- Constants defined once and imported 150- Types/interfaces reused, not redefined 151152### 7. Performance 153154**Backend:** 155- Expensive operations do not block requests 156- Batch database calls when possible 157- Set cache headers correctly 158159**Frontend (if applicable):** 160- Implement code splitting 161- Optimize images 162- Avoid massive dependencies for small utilities 163- Use lazy loading for heavy components 164165### 8. Documentation 166167**README.md must include:** 168- Description of what the project does 169- Instructions for installation and execution 170- Required environment variables 171- Guidance on running tests 172173**Code comments:** 174- Explain WHY, not WHAT 175- Provide explanations for complex logic 176- Avoid comments that merely repeat the code 177178### 9. Testing 179180- Critical paths should have tests (auth, payments, core features) 181- No `test.only` or `fdescribe` should remain in the code 182- Avoid `test.skip` without an explanation 183- Tests should verify behavior, not implementation details 184185### 10. Final Verification 186187After making all changes, run the app. Ensure nothing is broken. Check that: 188- The app starts without errors 189- Main features work 190- Tests pass (if they exist) 191- No regressions have been introduced 192193## Output Format 194195After auditing, provide a report: 196197```198CODEBASE AUDIT COMPLETE 199200FILES REMOVED: 201- node_modules/ (build artifact) 202- .env (contained secrets) 203- old_backup.js (unused duplicate) 204205CODE CHANGES: 206[src/api/users.js] 207 ✂ Removed unused import: lodash 208 ✂ Removed dead function: formatOldWay() 209 🔧 Renamed 'data' → 'userData' for clarity 210 🛡 Added try/catch around API call (line 47) 211212[src/db/queries.js] 213 ⚡ Fixed N+1 query: now uses JOIN instead of loop 214215SECURITY ISSUES: 216🚨 CRITICAL: Hardcoded API key in config.js (line 12) → moved to .env 217⚠️ HIGH: SQL injection risk in search.js (line 34) → fixed with parameterized query 218219SCALABILITY: 220⚡ Added pagination to /api/users endpoint 221⚡ Added index on users.email column 222223FINAL STATUS: 224✅ CLEAN - Ready to push to GitHub 225226Scores: 227Security: 9/10 (one minor header missing) 228Code Quality: 10/10 229Scalability: 9/10 230Overall: 9/10 231``` 232233## Key Principles 234235- Read the code thoroughly, don't skim 236- Fix issues immediately, don’t just document them 237- If uncertain about removing something, ask the user 238- Test after making changes 239- Be thorough but practical—focus on real problems 240- Security issues are blockers—nothing should ship with critical vulnerabilities 241242## Related Skills 243244- `@security-auditor` - Deeper security review 245- `@systematic-debugging` - Investigate specific issues 246- `@git-pushing` - Push code after audit247248## Limitations249- Use this skill only when the task clearly matches the scope described above.250- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.251- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.