Align docs and CI validation coverage#120
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR aligns the repository documentation and CI to better reflect (and validate) the current Python tooling under scripts/python, by expanding Python syntax validation coverage in CI and documenting the expected local validation steps.
Changes:
- Add explicit Python dependencies for MCP tooling and YAML parsing (
scripts/python/requirements.txt). - Update CI to install Python dependencies and compile all Python files under
scripts/pythonbefore running unit tests. - Simplify/refresh README content around repo structure and Python validation/routing tooling notes.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| scripts/python/requirements.txt | Adds explicit minimum versions for Python dependencies used by tooling/tests. |
| README.md | Updates documentation (repo structure, local validation commands, and Python tools notes). |
| .github/workflows/script-validation.yml | Expands Python syntax validation scope and installs Python deps before running unit tests. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
30
to
+34
| | | |-- codex_cost_router.py | ||
| | | |-- codex_cost_profiles.py | ||
| | | |-- litellm-cost-routing.yaml | ||
| | | |-- mcp_server.py | ||
| | | `-- requirements.txt | ||
| | | |-- risk_adjusted_router.py |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What Problem This Solves
The repository documentation and CI validation coverage were slightly out of sync. Some Python tools were documented but not covered by the Python syntax validation step, and Python dependencies were not installed before running the Python test suite.
Why This Change Was Made
This change expands Python CI validation to all Python files under
scripts/python, installs the declared Python dependencies before tests, and adds a reusable pull request template so future pushes and merges follow a consistent evidence-based structure.User Impact
No runtime behavior changes. Maintainers get clearer validation, better documentation alignment, and a standard PR format for future changes.
Evidence
Script Validationcompleted successfully on the PR head.