https://github.com/StyraInc/rego-style-guide

Style guide for Rego
https://github.com/StyraInc/rego-style-guide

best-practices opa open-policy-agent policy-as-code rego style-guide styra

Last synced: 2 months ago
JSON representation

Style guide for Rego

• Host: GitHub
• URL: https://github.com/StyraInc/rego-style-guide
• Owner: StyraInc
• License: apache-2.0
• Created: 2022-05-13T12:58:26.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-29T10:22:01.000Z (5 months ago)
• Last Synced: 2024-08-30T11:20:05.981Z (5 months ago)
• Topics: best-practices, opa, open-policy-agent, policy-as-code, rego, style-guide, styra
• Homepage: https://docs.styra.com/opa/rego-style-guide
• Size: 139 KB
• Stars: 196
• Watchers: 20
• Forks: 10
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-opa - Rego Style Guide - Style guide for Rego, providing pointers on best practices for policy authoring (Official projects / Docs)

README

        
# Rego Style Guide

This repository contains source code for the

[Rego Style Guide](https://docs.styra.com/opa/rego-style-guide).

The purpose of this style guide is to provide a collection of recommendations

and best practices for authoring

[Rego](https://www.openpolicyagent.org/docs/latest/policy-language/).

From [Styra](https://www.styra.com), the founders of

[Open Policy Agent](https://www.openpolicyagent.org) (OPA),

and some of the most experienced members of the community,

we hope to share lessons learnt from authoring and reviewing hundreds of

thousands of lines of Rego over the years.

> [!NOTE]

> You might also be interested in checking out [Regal](https://docs.styra.com/regal),

> the new linter for Rego from Styra.

If you are interested in suggesting changes to the guide's content,

please feel free to raise an issue or PR on this repo. The document

containing the guide's content can be found in `style-guide.md`.

For questions, discussions and announcements related to Styra products,

services and open source projects, please join the

[Styra community on Slack](https://communityinviter.com/apps/styracommunity/signup)!