Improve wording and add missing documentation for rmdepcheck and license-validate - #1169
Improve wording and add missing documentation for rmdepcheck and license-validate#1169betulependule wants to merge 2 commits into
rmdepcheck and license-validate#1169Conversation
Made some improvements to make the documentation easier to read and added consistency to heading capitalization.
|
🤖 Finished Review · ✅ Success · Started 2:16 PM UTC · Completed 2:27 PM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $2.31 |
|
Build succeeded. ✔️ pre-commit SUCCESS in 1m 08s |
ReviewFindingsLow
|
| in [Testing Farm](https://testing-farm.io) run with a successful scratch build. | ||
| ### installability | ||
|
|
||
| [installability test](https://github.com/fedora-ci/installability-pipeline), |
There was a problem hiding this comment.
[low] naming-convention
The heading ### installability uses all-lowercase, diverging from the sentence-case convention used in higher-level headings (e.g., ## Scratch builds). However, within the ## Tests section, the pre-existing headings ### rpmlint and ### rpminspect already used lowercase as canonical tool names. This PR normalizes installability to match its siblings and the exact CLI identifier used in /packit-ci test installability — a defensible editorial choice.
Suggested fix: If the project prefers sentence case for all headings, change to ### Installability. Otherwise, the current lowercase is consistent with sibling test headings.
|
|
||
| ### Custom test plans | ||
| ### custom test plans | ||
|
|
There was a problem hiding this comment.
[low] naming-convention
The heading ### custom test plans uses all-lowercase, changed from the previous ### Custom test plans. Unlike tool-name headings (rpmlint, rpminspect, installability), 'custom test plans' is a descriptive phrase rather than a canonical tool identifier, so the case for keeping it capitalized is stronger. The PR is establishing a uniform lowercase style for all test sub-headings to match their CLI identifiers.
Suggested fix: Consider restoring to ### Custom test plans since this is a descriptive phrase, not a tool name. Alternatively, if the project decides all test headings should match their CLI identifiers, the lowercase is acceptable.
Improved the wording of the Fedora CI tests sections and added missing documentation in relation to
rmdepcheckandlicense-validate.