main @ 01f875a590-100
+75-89
+60-74
+40-59
+0-39
+Add or improve CI/CD pipeline configuration
+ + +# Create GitHub Actions workflow
+mkdir -p .github/workflows
+touch .github/workflows/ci.yml
+
+# Validate workflow
+gh workflow view ci.yml# .github/workflows/ci.yml - Good example
+
+name: CI Pipeline
+
+on:
+ push:
+ branches: [main]
+ pull_request:
+ branches: [main]
+
+jobs:
+ lint:
+ name: Lint Code
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+
+ - name: Set up Python
+ uses: actions/setup-python@v5
+ with:
+ python-version: '3.11'
+ cache: 'pip' # Caching
+
+ - name: Install dependencies
+ run: pip install -r requirements.txt
+
+ - name: Run linters
+ run: |
+ black --check .
+ isort --check .
+ ruff check .
+
+ test:
+ name: Run Tests
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+
+ - name: Set up Python
+ uses: actions/setup-python@v5
+ with:
+ python-version: '3.11'
+ cache: 'pip'
+
+ - name: Install dependencies
+ run: pip install -r requirements.txt
+
+ - name: Run tests with coverage
+ run: pytest --cov --cov-report=xml
+
+ - name: Upload coverage reports
+ uses: codecov/codecov-action@v3
+ with:
+ files: ./coverage.xml
+
+ build:
+ name: Build Package
+ runs-on: ubuntu-latest
+ needs: [lint, test] # Runs after lint/test pass
+ steps:
+ - uses: actions/checkout@v4
+
+ - name: Build package
+ run: python -m build
+
+ - name: Upload build artifacts
+ uses: actions/upload-artifact@v3
+ with:
+ name: dist
+ path: dist/
+Document single-file lint and type-check commands in CLAUDE.md/AGENTS.md
+ + +# Python
+ruff check path/to/file.py
+mypy path/to/file.py
+
+# JavaScript/TypeScript
+npx eslint path/to/file.ts
+npx tsc --noEmit path/to/file.tsOrganize code into standard directories
+ + +# Option A: src layout
+mkdir -p src/mypackage
+touch src/mypackage/__init__.py
+# ---
+# Option B: flat layout (project-named)
+mkdir -p mypackage
+touch mypackage/__init__.py
+# Create tests directory
+mkdir -p tests
+touch tests/__init__.py
+touch tests/test_example.py# src layout (recommended for distributable packages)
+project/
+├── src/
+│ └── mypackage/
+│ ├── __init__.py
+│ └── module.py
+├── tests/
+│ └── test_module.py
+└── pyproject.toml
+
+# flat layout (common in major projects like pandas, numpy)
+project/
+├── mypackage/
+│ ├── __init__.py
+│ └── module.py
+├── tests/
+│ └── test_module.py
+└── pyproject.toml
+Add lock file for dependency reproducibility
+ + +npm install # npm
+pip freeze > requirements.txt # Python
+poetry lock # Python with PoetryConfigure security scanning for dependencies and code
+ + +gh repo edit --enable-security
+pip install pre-commit detect-secrets
+pre-commit install# .github/dependabot.yml
+version: 2
+updates:
+ - package-ecosystem: pip
+ directory: /
+ schedule:
+ interval: weekly# renovate.json
+{
+ "extends": ["config:base"],
+ "schedule": "after 10pm every weekday"
+}# .pre-commit-config.yaml
+repos:
+ - repo: https://github.com/Yelp/detect-secrets
+ rev: v1.4.0
+ hooks:
+ - id: detect-secretsConfigure conventional commits with commitlint
+ + +# Python (pre-commit):
+pip install pre-commit && pre-commit install --hook-type commit-msg
+# JS (commitlint + husky):
+npm install --save-dev @commitlint/cli @commitlint/config-conventional huskyCreate single-command setup for development environment
+ + +# Example Makefile
+cat > Makefile << 'EOF'
+.PHONY: setup
+setup:
+ python -m venv venv
+ . venv/bin/activate && pip install -r requirements.txt
+ pre-commit install
+ cp .env.example .env
+ @echo 'Setup complete! Run make test to verify.'
+EOF# Quick Start section in README
+
+## Quick Start
+
+```bash
+make setup # One command to set up development environment
+make test # Run tests to verify setup
+```
+Refactor large files into smaller, focused modules
+ + +# Split large file:
+# models.py (1500 lines) → models/user.py, models/product.py, models/order.pyDocument design intent: preconditions, invariants, and rationale
+ + +mkdir -p docs/design# docs/design/event-system.md
+## Invariants
+- Event log is append-only; never mutate or delete entries
+- Events are processed exactly-once via idempotency keys
+
+## Preconditions
+- Auth middleware must validate token before event handlers run
+
+## Rationale
+- Polling instead of webhooks: upstream API has 5s delivery SLA, too slow for our use caseConfigure Repomix for AI-friendly context generation
+ + +agentready repomix-generate --init
+agentready repomix-generate# Initialize Repomix configuration
+agentready repomix-generate --init
+
+# Generate repository context
+agentready repomix-generate
+
+# Check freshness
+agentready repomix-generate --checkCreate Architecture Decision Records (ADRs) directory and document key decisions
+ + +# Create ADR directory
+mkdir -p docs/adr
+
+# Create first ADR using template
+cat > docs/adr/0001-use-architecture-decision-records.md << 'EOF'
+# 1. Use Architecture Decision Records
+
+Date: 2025-11-22
+
+## Status
+Accepted
+
+## Context
+We need to record architectural decisions made in this project.
+
+## Decision
+We will use Architecture Decision Records (ADRs) as described by Michael Nygard.
+
+## Consequences
+- Decisions are documented with context
+- Future contributors understand rationale
+- ADRs are lightweight and version-controlled
+EOF# Example ADR Structure
+
+```markdown
+# 2. Use PostgreSQL for Database
+
+Date: 2025-11-22
+
+## Status
+Accepted
+
+## Context
+We need a relational database for complex queries and ACID transactions.
+Team has PostgreSQL experience. Need full-text search capabilities.
+
+## Decision
+Use PostgreSQL 15+ as primary database.
+
+## Consequences
+- Positive: Robust ACID, full-text search, team familiarity
+- Negative: Higher resource usage than SQLite
+- Neutral: Need to manage migrations, backups
+```
+Configure 3 missing linter(s)
+ + +go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
+npm install --save-dev markdownlint-cli && touch .markdownlint.json# .pylintrc example
+[MASTER]
+max-line-length=100
+
+[MESSAGES CONTROL]
+disable=C0111# .eslintrc.json example
+{
+ "extends": "eslint:recommended",
+ "rules": {
+ "no-console": "warn"
+ }
+}Create GitHub issue and PR templates in .github/ directory
+ + +# Create directories
+mkdir -p .github/ISSUE_TEMPLATE
+
+# Create PR template
+cat > .github/PULL_REQUEST_TEMPLATE.md << 'EOF'
+## Summary
+<!-- Describe the changes in this PR -->
+
+## Related Issues
+Fixes #
+
+## Testing
+- [ ] Tests added/updated
+- [ ] All tests pass
+
+## Checklist
+- [ ] Documentation updated
+- [ ] CHANGELOG.md updated
+EOF# Bug Report Template (.github/ISSUE_TEMPLATE/bug_report.md)
+
+```markdown
+---
+name: Bug Report
+about: Create a report to help us improve
+title: '[BUG] '
+labels: bug
+assignees: ''
+---
+
+**Describe the bug**
+A clear description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce:
+1. Go to '...'
+2. Click on '....'
+3. See error
+
+**Expected behavior**
+What you expected to happen.
+
+**Environment**
+- OS: [e.g. macOS 13.0]
+- Version: [e.g. 1.0.0]
+```
+