Quote Arcane Auditor's rule documentation verbatim - #12
Merged
Conversation
Each Arcane rule section now carries Arcane's own reasoning, example, and recommendation exactly as describe-rule prints them for v2.0.0. Only the severity line and any hub policy note are the hub's.
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.
What this PR adds or changes
Each of the 48 Arcane rule sections in
docs/EXAMPLE_BEST_PRACTICES.mdnow carries Arcane Auditor's own reasoning, before-and-after example, and recommendation exactly asArcaneAuditorCLI describe-rule <RuleId>prints them for v2.0.0. Only the severity line and the three hub policy notes are the hub's. The intro says so. Rule-id headings are unchanged, so audit links keep resolving.Anything reviewers should know?
This is the commit that landed on the previous branch after #10 was merged. Docs only.