Skip to content

Improve wording and add missing documentation for rmdepcheck and license-validate - #1169

Open
betulependule wants to merge 2 commits into
packit:mainfrom
betulependule:fedora-ci/test-identifiers
Open

Improve wording and add missing documentation for rmdepcheck and license-validate#1169
betulependule wants to merge 2 commits into
packit:mainfrom
betulependule:fedora-ci/test-identifiers

Conversation

@betulependule

Copy link
Copy Markdown
Contributor

Improved the wording of the Fedora CI tests sections and added missing documentation in relation to rmdepcheck and license-validate.

Made some improvements to make the documentation easier to read
and added consistency to heading capitalization.
@fullsend-ai-review

fullsend-ai-review Bot commented Aug 31, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 2:16 PM UTC · Completed 2:27 PM UTC

Commit: 15c5979 · View workflow run →

Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $2.31

@centosinfra-prod-github-app

Copy link
Copy Markdown
Contributor

@fullsend-ai-review

Copy link
Copy Markdown

Review

Findings

Low

  • [naming-convention] fedora-ci/jobs.md:17 — 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.

  • [naming-convention] fedora-ci/jobs.md:43 — The heading ### custom test plans uses all-lowercase, changed from the previous ### Custom test plans. Unlike the tool-name headings, "custom test plans" is a descriptive phrase rather than a canonical identifier, so the case for sentence-case capitalization is stronger. Consider restoring ### Custom test plans if the project prefers sentence case for descriptive headings, or keep it lowercase if the intent is uniform casing across all test sub-headings.

Comment thread fedora-ci/jobs.md
in [Testing Farm](https://testing-farm.io) run with a successful scratch build.
### installability

[installability test](https://github.com/fedora-ci/installability-pipeline),

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

Comment thread fedora-ci/jobs.md

### Custom test plans
### custom test plans

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

@fullsend-ai-review fullsend-ai-review Bot added the ready-for-merge All reviewers approved — ready to merge label Aug 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-for-merge All reviewers approved — ready to merge

Projects

Development

Successfully merging this pull request may close these issues.

2 participants