Skip to content

Commit

Permalink
Update CONTENTSTYLEGUIDE.md
Browse files Browse the repository at this point in the history
Co-authored-by: Addam Schroll <108814318+schrolla@users.noreply.github.com>
  • Loading branch information
Sloane4 and schrolla authored Nov 27, 2023
1 parent 153984f commit 2eaa738
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTENTSTYLEGUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use menu icon on the top left corner of this document to get to a specific secti

## OPA Rego

OPA has a style guide [Styra](https://github.com/StyraInc/rego-style-guide), that we are adopting, except where our guide specifically notes an exception (for example, variable name case). For consistency, we will be using many of the same style rules as PowerShell. There are also a few best practice rules that this program will follow. These best practices were deliberated on and chosen to enhance readability. We recognize that the code is in a constant state of improvement, so the best practices are subject to change. Also note the use of Regal linter is highly encourage for style formatting.
The project is adopting the following public Rego [style guide](https://github.com/StyraInc/rego-style-guide), except where our guide specifically notes an exception (e.g., variable name case). For consistency, we will be using many of the same style rules as PowerShell. There are also a few best practice rules that this project will follow. These best practices were chosen to enhance readability. We recognize that the code is in a constant state of improvement, so the best practices are subject to change. The project is also integrating the [Regal](https://github.com/StyraInc/regal) linter into its automated checks to promote style guide adherence.

### Test Cases

Expand Down

0 comments on commit 2eaa738

Please sign in to comment.