Conversation
WalkthroughAdds a new CONTRIBUTING.md that documents contribution procedures for the DRA Driver for SR-IOV Virtual Functions: meetings, how to contribute, coding style, patch/commit format and examples, contributor workflow, contact info, and project links. (≈50 words) Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Pre-merge checks✅ Passed checks (3 passed)
📜 Recent review detailsConfiguration used: Organization UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 Fix all issues with AI Agents
In @CONTRIBUTING.md:
- Around line 3-8: The table of contents contains a duplicate "Contributing
Code" link (both "How to Contribute" and "Contributing Code" point to
#contributing-code) and a broken "Tools" link (#Tools) with no corresponding
section; fix by removing the duplicate TOC entry (delete either the "How to
Contribute" or the "Contributing Code" line) or, if a Tools section is intended,
add a "## Tools" section matching the #Tools fragment, and ensure the anchor
fragment is lowercase and consistent (#contributing-code / #tools) so links
resolve correctly.
- Line 65: Remove the duplicated phrase "For the feature requests" in the bullet
that currently reads '* **For feature requests**, For the feature requests,
please follow the issue template format...' and consolidate it to a single,
natural sentence such as "For feature requests, please follow the issue template
format while creating a feature request." Ensure the redundant fragment is
deleted and grammar is adjusted (singular "a feature request" or plural
consistently) so the bullet reads clearly.
- Around line 31-57: Fix the malformed markdown link "[here]
(http://chris.beams.io/posts/git-commit/)" by removing the space so it becomes
"[here](http://chris.beams.io/posts/git-commit/)", and add language identifiers
to the fenced code blocks that contain the patch examples (the top fence around
"Change summary..." and the example fence around "Fix poorly named identifiers")
— e.g., use ```text or ```md for plain text examples (or ```bash for shell
snippets) so editors render syntax highlighting correctly.
- Around line 58-87: Fix grammatical errors and mark shell blocks: change "We
ask developer" to "We ask developers" and change "Please make sure each PR are
compiling or passed by Travis." to "Please make sure each PR compiles or passes
CI" (or "is compiled and passes CI") to correct subject-verb agreement and
improve clarity; also add language identifiers to the two fenced code blocks
containing the git commands (the ``git clone...`` and ``git checkout -b...``
blocks) by replacing their triple-backtick fences with ones labeled as bash
(e.g., ```bash) so the commands are syntax-highlighted.
- Around line 88-93: In the "Contact Us" section of CONTRIBUTING.md, correct
capitalization and typos: change "slack" to "Slack", replace "invite" with the
more formal "invitation" in the NPWG invite sentence, and fix the misspelling
"mangement" to "management" in both occurrences of "K8s Network & Resource
management" (ensure consistent capitalization for that meeting name); also
consider pluralizing "contributor" to "contributors" earlier in the paragraph
for grammar consistency.
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
60-67: Improve clarity and reduce wordiness in Contributing Code section.Lines 60-67 contain wordy phrasing that could be tightened. "On a regular basis" (line 63) should be "regularly," and "In order to ensure" (line 67) should be "To ensure." The opening paragraph at line 60 is also awkwardly phrased and would benefit from restructuring for clarity.
🔎 Proposed rewording for clarity
-We always encourage the contribution for the community project. We like to collaborate with various stake holder on this project. We ask developer to keep following guidelines in mind before the contribution. +We encourage community contributions and collaborate with various stakeholders. Please keep these guidelines in mind when contributing: * Make sure to create an [Issue](https://github.com/k8snetworkplumbingwg/dra-driver-sriov/issues) for bug fix or the feature request. -Issues are discussed on a regular basis at _K8s Network & Resource management_ meetings. +Issues are discussed regularly at _K8s Network & Resource management_ meetings. * **For feature requests**, For the feature requests, please follow the issue template format while creating a feature requests. We want to improve upon DRA Driver for SR-IOV incrementally which means small changes or features at a time. * Please make sure each PR are compiling or passed by Travis. - * In order to ensure your PR can be reviewed in a timely manner, please keep PRs small + * To ensure your PR is reviewed promptly, please keep it small.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[style] ~60-~60: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...h various stake holder on this project. We ask developer to keep following guideli...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~63-~63: ‘on a regular basis’ might be wordy. Consider a shorter alternative.
Context: ...e feature request. Issues are discussed on a regular basis at K8s Network & Resource management ...
(EN_WORDINESS_PREMIUM_ON_A_REGULAR_BASIS)
[style] ~66-~66: Consider using a different verb to strengthen your wording.
Context: ...anges or features at a time. * Please make sure each PR are compiling or passed by Trav...
(MAKE_SURE_ENSURE)
[style] ~67-~67: Consider a more concise word here.
Context: ... are compiling or passed by Travis. * In order to ensure your PR can be reviewed in a tim...
(IN_ORDER_TO_PREMIUM)
[style] ~91-~91: The noun “invitation” is usually used instead of ‘invite’ in formal writing.
Context: ...npwg-team.slack.com/) Slack. Request an invite to NPWG slack [here](https://intel-corp...
(AN_INVITE)
[uncategorized] ~91-~91: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ....com/) Slack. Request an invite to NPWG slack [here](https://intel-corp.herokuapp.com...
(ON_SKYPE)
[style] ~92-~92: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...](https://intel-corp.herokuapp.com/). - Feel free to post GitHub issues and PRs for review -...
(FEEL_FREE_TO_STYLE_ME)
[grammar] ~93-~93: Ensure spelling is correct
Context: ... - Attend either K8s Network & Resource mangement or Additional K8s Network & Resource ma...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
CONTRIBUTING.md
8-8: Link fragments should be valid
(MD051, link-fragments)
35-35: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
48-48: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
73-73: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
74-74: Dollar signs used before commands without showing output
(MD014, commands-show-output)
79-79: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
80-80: Dollar signs used before commands without showing output
(MD014, commands-show-output)
91-91: Link text should be descriptive
(MD059, descriptive-link-text)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Unit Tests
- GitHub Check: Lint
- GitHub Check: Build Container
Pull Request Test Coverage Report for Build 22134131699Details
💛 - Coveralls |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
CONTRIBUTING.md (4)
59-59: Consolidate repetitive sentence structure.The paragraph begins with three consecutive sentences starting with "We," which weakens readability. Consider combining these into a more concise, unified statement.
🔎 Proposed improvement
-We always encourage the contribution for the community project. We like to collaborate with various stake holder on this project. We ask developers to keep following guidelines in mind before the contribution. +We encourage contributions to this community project and collaborate with various stakeholders. Please keep the following guidelines in mind before contributing:
62-62: Simplify wordy phrase.Replace "on a regular basis" with more concise alternatives like "regularly" or "at each meeting."
🔎 Proposed improvement
-Issues are discussed on a regular basis at _K8s Network & Resource management_ meetings. +Issues are discussed regularly at _K8s Network & Resource management_ meetings.
65-66: Strengthen word choice and add missing punctuation.Line 65 uses "make sure" where "ensure" is stronger; line 66 has verbose "in order to" and appears to end without a period.
🔎 Proposed improvement
- * Please make sure each PR compiles and passes CI. - * In order to ensure your PR can be reviewed in a timely manner, please keep PRs small + * Ensure each PR compiles and passes CI. + * To ensure timely review, keep PRs small.
90-90: Use descriptive link text instead of "here".Replace generic "[here]" with descriptive text that conveys the link's purpose.
🔎 Proposed improvement
-Request an invitation to NPWG Slack [here](https://intel-corp.herokuapp.com/). +Request an invitation to NPWG Slack [via the signup form](https://intel-corp.herokuapp.com/).
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[style] ~59-~59: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...h various stake holder on this project. We ask developers to keep following guidel...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~62-~62: ‘on a regular basis’ might be wordy. Consider a shorter alternative.
Context: ...e feature request. Issues are discussed on a regular basis at K8s Network & Resource management ...
(EN_WORDINESS_PREMIUM_ON_A_REGULAR_BASIS)
[style] ~65-~65: Consider using a different verb to strengthen your wording.
Context: ...anges or features at a time. * Please make sure each PR compiles and passes CI. * In ...
(MAKE_SURE_ENSURE)
[style] ~66-~66: Consider a more concise word here.
Context: ...ure each PR compiles and passes CI. * In order to ensure your PR can be reviewed in a tim...
(IN_ORDER_TO_PREMIUM)
[style] ~91-~91: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...](https://intel-corp.herokuapp.com/). - Feel free to post GitHub issues and PRs for review -...
(FEEL_FREE_TO_STYLE_ME)
🪛 markdownlint-cli2 (0.18.1)
CONTRIBUTING.md
73-73: Dollar signs used before commands without showing output
(MD014, commands-show-output)
79-79: Dollar signs used before commands without showing output
(MD014, commands-show-output)
90-90: Link text should be descriptive
(MD059, descriptive-link-text)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Build Container
- GitHub Check: Lint
- GitHub Check: Unit Tests
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Fix all issues with AI Agents
In @CONTRIBUTING.md:
- Around line 26-28: Fix the subject-verb agreement in the "Coding Style"
section by changing the sentence "Please follows the standard formatting
recommendations..." to "Please follow the standard formatting
recommendations..." so the verb agrees with the imperative subject; update the
text where the phrase appears (the "Coding Style" heading and its following
sentence).
- Around line 72-74: The example shell command in the CONTRIBUTING.md code block
includes a leading "$" prompt which violates MD014 because no output is shown;
edit the fenced code block containing the git clone example to remove the "$" so
the block reads as a plain bash snippet starting with "git clone
https://github.com/k8snetworkplumbingwg/dra-driver-sriov.git" and ensure the
opening and closing ```bash fences remain intact.
- Around line 78-80: The code block in CONTRIBUTING.md shows a shell command
with a leading "$" prompt; remove the prompt so the example is just the command
text and ensure the fenced block is proper markdown (use triple backticks and
"bash" language tag) so replace "`$ git checkout -b dev/some-topic-branch`" with
a plain "`git checkout -b dev/some-topic-branch`" line inside the existing
```bash fenced block.
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
89-91: Consider a more formal tone for consistency.The phrase "Feel free to post GitHub issues and PRs for review" at line 91 is slightly informal compared to the rest of the document. Consider rephrasing to something like "Post GitHub issues and PRs for review" or "You can post GitHub issues and PRs for review" for a more professional tone.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[style] ~91-~91: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...(https://npwg-team.slack.com/) Slack. - Feel free to post GitHub issues and PRs for review -...
(FEEL_FREE_TO_STYLE_ME)
🪛 markdownlint-cli2 (0.18.1)
CONTRIBUTING.md
73-73: Dollar signs used before commands without showing output
(MD014, commands-show-output)
79-79: Dollar signs used before commands without showing output
(MD014, commands-show-output)
SchSeba
left a comment
SchSeba
left a comment
There was a problem hiding this comment.
looks good just small changes
CONTRIBUTING.md
Outdated
|
|
||
|
|
||
| * [Meeting notes and agenda](https://docs.google.com/document/d/1sJQMHbxZdeYJPgAWK1aSt6yzZ4K_8es7woVIrwinVwI/edit?usp=sharing) | ||
| * [Zoom channel](https://us02web.zoom.us/j/88973596231?pwd=UHZtUEtNSVBSYnRLL3A3cHMzdmlvZz09) |
There was a problem hiding this comment.
please update the meeting link https://meet.jit.si/K8sNetworkResourceManagementWG
CONTRIBUTING.md
Outdated
| Join us for project discussions at _K8s Network & Resource management_ meetings. | ||
| The meetings take place on a weekly basis on Monday and Tuesday in alternating weeks: | ||
|
|
||
| * Time: 15:00 - 16:00 GMT / 10:00-11:00 ET / 07:00-08:00 PST every other Monday |
There was a problem hiding this comment.
please put on like the line below no?
CONTRIBUTING.md
Outdated
| Issues are discussed regularly at _K8s Network & Resource management_ meetings. | ||
| * **For bugs**: For the bug fixes, please follow the issue template format while creating a issue. If you have already found a fix, feel free to submit a Pull Request referencing the Issue you created. Include the `Fixes #` syntax to link it to the issue you're addressing. | ||
| * **For feature requests**: Please follow the issue template format while creating a feature request. We want to improve upon DRA Driver for SR-IOV incrementally which means small changes or features at a time. | ||
| * Ensure each PR compiles and passes CI. |
There was a problem hiding this comment.
nit: more the empty space at the beginning
CONTRIBUTING.md
Outdated
| * **For bugs**: For the bug fixes, please follow the issue template format while creating a issue. If you have already found a fix, feel free to submit a Pull Request referencing the Issue you created. Include the `Fixes #` syntax to link it to the issue you're addressing. | ||
| * **For feature requests**: Please follow the issue template format while creating a feature request. We want to improve upon DRA Driver for SR-IOV incrementally which means small changes or features at a time. | ||
| * Ensure each PR compiles and passes CI. | ||
| * To ensure timely review, keep PRs small. |
There was a problem hiding this comment.
nit: more the empty space at the beginning
Signed-off-by: Fred Rolland <frolland@nvidia.com>
rollandf
force-pushed
the
contributing
branch
from
9b2ef23 to
5268fb7
Compare
4 participants
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.