Skip to content

open-policy-agent/rego-style-guide

Repository files navigation

Important

Note: This repo has recently been donated to the OPA GitHub organization and we are in the process of integrating it into the OPA website. There may be some references to the repo's previous location while we do that.

Rego Style Guide

This repository contains source code for the Rego Style Guide.

The purpose of this style guide is to provide a collection of recommendations and best practices for authoring Rego.

This repo is informed by OPA maintainers 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, the linter and language server for Rego, which automates many style guide recommendations.

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.