Skip to content

Update: best-practices repo with docs, CI, tests, and latest deps#8

Merged
Varnasr merged 1 commit intomainfrom
claude/review-repo-improvements-i6mvD
Apr 4, 2026
Merged

Update: best-practices repo with docs, CI, tests, and latest deps#8
Varnasr merged 1 commit intomainfrom
claude/review-repo-improvements-i6mvD

Conversation

@Varnasr
Copy link
Copy Markdown
Owner

@Varnasr Varnasr commented Apr 4, 2026

Summary

Comprehensive repo upgrade to bring BridgeStack up to best-practices standards:

  • Dependencies: Bumped all deps to latest (FastAPI 0.115+, Pydantic 2.11+, SQLAlchemy 2.0.40+, Uvicorn 0.34+, Ruff 0.11+)
  • CI/CD: Upgraded pipeline with pytest + coverage, ruff lint/format checks, and Python 3.11/3.12/3.13 matrix testing
  • Tests: Expanded from 14 basic tests → 45 comprehensive tests with realistic Indian development data fixtures (states, districts, indicators, schemes, budgets, coverage, tools)
  • Health endpoint: Now verifies database connectivity and returns healthy/degraded status with version info
  • Structured logging: Configurable log level via BRIDGE_LOG_LEVEL env var
  • Documentation: GitBook-style docs/ folder with getting-started, API reference, architecture, configuration, and deployment guides
  • Community files: Added CONTRIBUTING.md, CODE_OF_CONDUCT.md, .env.example, Makefile
  • Modern config: Added pyproject.toml with ruff, pytest, and coverage configuration
  • Version bump: 0.2.0 → 0.3.0

What Changed

Area Before After
Tests 14 (empty + 404 only) 45 (with data, filters, all endpoints)
CI Syntax check only Lint + format + pytest + coverage + matrix
Docs README only Full docs/ site (5 pages)
Health {"status": "healthy"} DB check, version, degraded state
Deps Loose >=0.104 era Latest >=0.115 era
Tooling None Ruff, pytest-cov, Makefile

Test plan

  • All 45 tests pass locally
  • Ruff lint passes (ruff check .)
  • Ruff format passes (ruff format --check .)
  • CI pipeline runs on PR (new workflow)

https://claude.ai/code/session_01GzTxTLKq5FaDLE9YGGQ6WX

- Upgrade all dependencies to latest versions (FastAPI 0.115+, Pydantic 2.11+, SQLAlchemy 2.0.40+, etc.)
- Add pyproject.toml with modern Python project config, ruff linting, and pytest settings
- Upgrade CI pipeline: add pytest with coverage, ruff lint/format checks, multi-Python matrix (3.11-3.13)
- Improve health endpoint to verify database connectivity (healthy/degraded status)
- Add structured logging with configurable log level
- Expand test suite from 14 to 45 tests with realistic data fixtures (conftest.py)
- Add CONTRIBUTING.md, CODE_OF_CONDUCT.md, .env.example, and Makefile
- Create GitBook-style docs/ with getting-started, API reference, architecture, configuration, and deployment guides
- Update README with CI badge, ruff badge, docs links, and cleaner structure
- Update ROADMAP with versioned milestones
- Bump version to 0.3.0

https://claude.ai/code/session_01GzTxTLKq5FaDLE9YGGQ6WX
@Varnasr Varnasr merged commit ba17fa9 into main Apr 4, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants