Quality explain #14264
Merged
Quality explain #14264
Conversation
This file contains 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
sgugger
force-pushed
the
quality_explain
branch
from
53b57d1
to
a46ed5d
Compare
stas00
approved these changes
Nov 3, 2021
Co-authored-by: Stas Bekman <stas00@users.noreply.github.com>
|
Thanks for the extended review @stas00 ! Will rename the page. |
LysandreJik
approved these changes
Nov 3, 2021
Albertobegue
pushed a commit
to Albertobegue/transformers
that referenced
this pull request
Jan 27, 2022
* Start PR doc * Cleanup the quality checks and document them * Add reference in the contributing guide * Apply suggestions from code review Co-authored-by: Stas Bekman <stas00@users.noreply.github.com> * Rename file as per review suggestion Co-authored-by: Stas Bekman <stas00@users.noreply.github.com>
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 does this PR do?
This PR reorganizes the quality checks by splitting the current
make qualityin two:make qualityis the check on code stylemake repo-consistencycontains all other general checks on the repoSimilarly in the CI checks, the old
check_repository_consistencycheck (that tested links used in the library are on S3 back in the pre-git repo days) performs the checks ofmake repo-consistency, whilecheck-code-qualityonly focuses on the code quality.In practice, nothing changes for the users of
make fixup, but users ofmake qualityhave to remember two different lines:make qualityandmake repo-consistency.I also have drafted a doc page explaining all those changes and what each check does (for advanced contributors as well as team members), with TODOs of checks I plan to add in the future.
One last future plan I also have is to make the
make repo-consistencycommand perform all checks and report all failures at the end (instead of stopping at the first one).