Migrate the add-enhancement command to ai-helpers #194
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: rikatz The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
WalkthroughAdds a new OpenShift plugin command for creating Enhancement Proposals: introduces a documentation/template Markdown for the command and registers the new command in plugin manifest files ( Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Pre-merge checks and finishing touchesImportant Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional. ❌ Failed checks (1 inconclusive)
✅ Passed checks (6 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
|
Hi @rikatz. Thanks for your PR. I'm waiting for a github.com member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
openshift-ci
bot
added
the
needs-ok-to-test
|
/cc @bentito |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
plugins/openshift/commands/add-enhancement.md (4)
10-12: Add language specification to fenced code block.The synopsis code block should specify a language identifier for proper rendering.
## Synopsis -``` +```bash /openshift:add-enhancement <area> <name> <description> <jira>--- `55-55`: **Grammar: Use "to be included" instead of "wants included".** ```diff - - Explicit Goals or Non-Goals the user wants included + - Explicit Goals or Non-Goals the user wants to be included
60-60: Reduce consecutive sentences starting with "Ask".Three successive bullet points begin with "Ask clarifying questions". Consider varying the phrasing for better readability.
- - Ask clarifying questions about telemetry, security, upgrade and downgrade process, rollbacks, dependencies, in case it is not possible to assert these fields. + - Clarify telemetry, security, upgrade and downgrade process, rollbacks, and dependencies in case these fields cannot be asserted.
92-96: Capitalize "Markdown" as a proper noun (formatting language name).- - Invalid markdown syntax (e.g., breaking markdown links, code blocks, or formatting) + - Invalid Markdown syntax (e.g., breaking Markdown links, code blocks, or formatting) - If breaking at 80 characters would split a URL, code, or markdown syntax, find the nearest valid break point such as: after a sentence, before a URL starts, after a URL ends, or at a natural paragraph break. For regular prose, it is acceptable to exceed 80 characters by 10-15 characters to avoid breaking words mid-word. Only allow lines >95 characters when the line contains a single unbreakable element (like a standalone URL with no surrounding text, or a single line of code). + If breaking at 80 characters would split a URL, code, or Markdown syntax, find the nearest valid break point such as: after a sentence, before a URL starts, after a URL ends, or at a natural paragraph break. For regular prose, it is acceptable to exceed 80 characters by 10-15 characters to avoid breaking words mid-word. Only allow lines >95 characters when the line contains a single unbreakable element (like a standalone URL with no surrounding text, or a single line of code).
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge base: Disabled due to data retention organization setting
📒 Files selected for processing (3)
PLUGINS.md(1 hunks)docs/data.json(1 hunks)plugins/openshift/commands/add-enhancement.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
plugins/openshift/commands/add-enhancement.md
[style] ~55-~55: The double modal “wants included” is nonstandard (only accepted in certain dialects). Consider “to be included”.
Context: ...licit Goals or Non-Goals the user wants included - Any specific technical constraints...
(NEEDS_FIXED)
[style] ~60-~60: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...oUpgrade or TechPreviewNoUpgrade). - Ask clarifying questions about telemetry, s...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~94-~94: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...before or after the URL) - Invalid markdown syntax (e.g., breaking markdown links, ...
(MARKDOWN_NNP)
[uncategorized] ~94-~94: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...Invalid markdown syntax (e.g., breaking markdown links, code blocks, or formatting) ...
(MARKDOWN_NNP)
[uncategorized] ~96-~96: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ... characters would split a URL, code, or markdown syntax, find the nearest valid break po...
(MARKDOWN_NNP)
🪛 markdownlint-cli2 (0.18.1)
plugins/openshift/commands/add-enhancement.md
10-10: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
41-41: Bare URL used
(MD034, no-bare-urls)
44-44: Bare URL used
(MD034, no-bare-urls)
59-59: Bare URL used
(MD034, no-bare-urls)
78-78: Bare URL used
(MD034, no-bare-urls)
78-78: Bare URL used
(MD034, no-bare-urls)
79-79: Bare URL used
(MD034, no-bare-urls)
79-79: Bare URL used
(MD034, no-bare-urls)
80-80: Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (2)
PLUGINS.md (1)
229-229: Entry is well-formatted and consistent with other documentation.The new command is properly registered in alphabetical order and follows the established documentation format.
docs/data.json (1)
607-612: JSON structure is valid and consistent with command metadata standards.Command entry is correctly formatted with matching argument hints and description from PLUGINS.md.
|
/ok-to-test |
openshift-ci
bot
added
ok-to-test
|
/assign bentito |
2 participants
What this PR does / why we need it:
Migrate the add-enhancement command from openshift/enhancements to ai-helpers.
This command helps on creating enhancement proposals for Openshift, reusing the existing template to help engineers focus on the writing of the feature and not on replicating the template.
Checklist:
Summary by CodeRabbit
New Features
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.