chore: OSS hygiene pass — CI, ruff, jupytext, dependabot, docs#4
Merged
Conversation
- pyproject: configure ruff (target-py311, line-length=100, sensible
rule set); ignore E501 (formatter handles), B905 (idiomatic zip)
- apply ruff format across kos/, tests/, examples/ — 6 files touched
- ci: lint (ruff check + format check), test (pytest 24 cases),
notebook-pairing-check (jupytext --sync verification)
- pair examples/{markout,vpin,if_stress}_demo.ipynb with their .py
shadows via jupytext metadata (formats=ipynb,py:percent); .ipynb
keeps outputs (README hero plots), .py is the diffable source
- add .github/dependabot.yml: weekly github-actions and uv updates
- add CONTRIBUTING.md: contribution scope, code style, pair workflow
- add SECURITY.md: vuln reporting to security@xylem-group.org
- README: CI / license / Python / Ruff badges
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Summary
Same hygiene pass that landed in paros (#8/#9/#12), tailored to kos.
ruff formatacrosskos/,tests/,examples/.formats = "ipynb,py:percent")..ipynbkeeps outputs for README hero plots;.pyis the diffable source. CI fails if pairings drift.Test plan
Notes
.ipynband.py; this PR makes the pairing canonical (jupytext metadata) so future edits stay in sync via tooling, not convention.🤖 Generated with Claude Code