Repository navigation
README.md documents the contributor workflow that CI enforces: installing with pip install -e ".[test]", running `pyth - #7
Merged
Conversation
Adds a README "Development" section with a fenced bash block: pip install -e ".[test]", python -m pytest -m "not slow", and python scripts/check_docs.py, plus the system tools CI installs (ffmpeg, libsndfile1, libchromaprint-tools for fpcalc). check_docs.py extracts the block (README.md:226-227); injecting a bogus flag into the check_docs command makes it report "`scripts/check_docs.py` does not accept --bogus", so the block is verified. Assumptions: - The section sits just before License, after the protocol docs, because it is for contributors, not benchmark users. - pytest is on check_docs' ignore list (third-party), so only the check_docs command's flags are machine-verified; --skip-flags is shown in prose and exists in its parser.
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.
Milestone of an auto-claude run.
Check:
grep -qF 'pip install -e ".[test]"' README.md && grep -qF 'pytest -m "not slow"' README.md && grep -qF 'python scripts/check_docs.py' README.md && ~/RTX_ENV/bin/python scripts/check_docs.py && systemd-run --user --scope -q -p MemoryMax=6G ~/RTX_ENV/bin/python -m pytest -m "not slow" -q -p no:cacheproviderPlan: .claude/auto-plan.md (local to the run).