Skip to content

Refactor contributions guide for improved readability #1509

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bradlitterell wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Refactor contributions guide for improved readability #1509

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions doc/contributions-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ operators, an increasing number of vendors and open source projects have
augmented the models with additional fields that have not fallen into the
initial "minimum operationally viable" approach that OpenConfig has taken.
However, this is not to say that these features are not used, or are not of
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 have many different augmentations covering the same feature set.
To this end, this document outlines a process for external contributions to OpenConfig.
Comment on lines +13 to +17

@gemini-code-assist gemini-code-assist Bot Jun 17, 2026

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.


OpenConfig considers schema consistency paramount -- since it greatly impacts
the usability of the models for consumers be they machine or human. As external
Expand Down
Loading