Refactor contributions guide for improved readability#1509
Open
bradlitterell wants to merge 1 commit into
Open
Refactor contributions guide for improved readability#1509bradlitterell wants to merge 1 commit into
bradlitterell wants to merge 1 commit into
Conversation
Reformat text, the dash divider was incorrectly being interpreted as markdown.
Contributor
There was a problem hiding this comment.
Code Review
This pull request reformats a paragraph in the contributions guide (doc/contributions-guide.md). The review feedback suggests minor grammatical corrections, improving parallel structure, and removing trailing spaces, which has been provided as a concrete code suggestion.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
Comment on lines
+13
to
+17
| interest for including in the models. It is desirable that these | ||
| augmentations - where they meet the style, and support requirements for | ||
| including in the models - be included within the standard set of models, | ||
| rather than have many different augmentations covering the same feature set. | ||
| To this end, this document outlines a process for external contributions to OpenConfig. |
Contributor
There was a problem hiding this comment.
There are a few minor grammatical and formatting issues in this paragraph:
- There is an unnecessary comma in "style, and support requirements" (since it is a simple two-item conjunction, not a list of three or more).
- The phrase "rather than have" is grammatically awkward here; "rather than having" flows better and maintains parallel structure.
- There are trailing spaces at the end of lines 13 and 16.
Suggested change
| interest for including in the models. It is desirable that these | |
| augmentations - where they meet the style, and support requirements for | |
| including in the models - be included within the standard set of models, | |
| rather than have many different augmentations covering the same feature set. | |
| To this end, this document outlines a process for external contributions to OpenConfig. | |
| interest for including in the models. It is desirable that these | |
| augmentations - where they meet the style and support requirements for | |
| including in the models - be included within the standard set of models, | |
| rather than having many different augmentations covering the same feature set. | |
| To this end, this document outlines a process for external contributions to OpenConfig. |
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
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.
Rewrap paragraph ending because the dash divider at the start of the line was incorrectly being interpreted as markdown bullet.