Fix linting paths in CONTRIBUTING.md for clarity#13
Open
The-Digital-Alchemist wants to merge 1 commit into
Open
Fix linting paths in CONTRIBUTING.md for clarity#13The-Digital-Alchemist wants to merge 1 commit into
The-Digital-Alchemist wants to merge 1 commit into
Conversation
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
Fixes an incorrect path in the contributor lint instructions.
CONTRIBUTING.mdstep 6 tells contributors to run:ruff check brain2qwerty/
ruff format --check brain2qwerty/
There is no
brain2qwerty/directory in the repo. The source packages arebrain2qwerty_v1/,brain2qwerty_v2/, andstudies/(as declared inpyproject.tomlunder[tool.setuptools.packages.find]). Because the path isresolved relative to the repo root,
ruff check brain2qwerty/targets anon-existent
./brain2qwerty/and exits with "No such file or directory", so thedocumented lint step silently checks nothing.
This PR updates both commands to point at the actual package directories:
ruff check brain2qwerty_v1/ brain2qwerty_v2/ studies/
ruff format --check brain2qwerty_v1/ brain2qwerty_v2/ studies/
Docs-only change; no source, config, or behavior is affected.
Test plan
pytestpasses locallyruff checkpasses (ruff format --checkreports 2 pre-existing diffsin files this PR does not touch)
Checklist