Skip to content

Refactor contributions guide for improved readability#1509

Open
bradlitterell wants to merge 1 commit into
openconfig:masterfrom
bradlitterell:patch-1
Open

Refactor contributions guide for improved readability#1509
bradlitterell wants to merge 1 commit into
openconfig:masterfrom
bradlitterell:patch-1

Conversation

@bradlitterell

Copy link
Copy Markdown

Rewrap paragraph ending because the dash divider at the start of the line was incorrectly being interpreted as markdown bullet.

Reformat text, the dash divider was incorrectly being interpreted as markdown.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

There are a few minor grammatical and formatting issues in this paragraph:

  1. 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).
  2. The phrase "rather than have" is grammatically awkward here; "rather than having" flows better and maintains parallel structure.
  3. 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

1 participant