Repository navigation
docs: align contributor lint guide with current CI - #2398
Open
Runqi Wang (Allen) (runqiwang777) wants to merge 1 commit into
Open
Runqi Wang (Allen) (runqiwang777) wants to merge 1 commit into
Runqi Wang (Allen) (runqiwang777) wants to merge 1 commit into
Conversation
Author
|
@microsoft-github-policy-service agree |
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.
Description
docs/developer/code_standard_and_dev_guide.rst, replace the two references to the historical.github/workflows/test.ymlat commit0e8b94awith a link to the current.github/workflows/test_qlib_from_source.yml.pip install blackandpython -m black . -l 120withpython -m pip install -e ".[lint]"andmake black. Explain thatblack <file> -l 120formats a changed file, whilemake blackchecks the repository.make pylint, and replace the copied flake8 command withmake flake8. These are the targets invoked by the current workflow.Motivation and Context
The guide still points to an older
test.ymlworkflow. The link works, but the flake8 anchor at#L73lands on “Test workflow by config (install from pip)” instead of a flake8 check. The current source-test workflow runsmake black,make pylint, andmake flake8.The copied flake8 command also ignores
F401,F821, andF841globally. The current Makefile target does not ignoreF821orF841and only makesF401/F403exceptions for__init__.py. Using the Makefile targets should help contributors get the same results locally as they do in CI. Thanks for taking a look!How Has This Been Tested?
pytest qlib/tests/test_all_pipeline.pyunder upper directory ofqlib.Compared the updated guide with the current source-test workflow, Makefile, and pyproject.toml.
git diff --checkandgit apply --checkpassed against the verified upstream file baseline. The updated RST parsed with docutils 0.23 without warnings, and the new workflow URL was recognized as a link. A full Sphinx build was not run because Sphinx was unavailable locally.Screenshots of Test Results (if appropriate):
Types of changes