Write a repository review configuration

Start from the root .proofline.yaml or .proofline.yml in the repository whose reviews you want to change. Keep one of those files. Each example below is a complete file; merge the relevant keys into your existing document.

Draft YAML in the repository configuration validation modal.
Validate a draft before committing .proofline.yaml. Validation saves nothing. Fictional demo workspace.

Choose which changes receive a review#

Write review instructions#

Declare architecture boundaries#

Repair YAML structure#

Validate and commit the change#

Open the repository’s Settings → Config file, choose Validate a draft config file, paste the complete file and select Validate draft. Commit the validated file through GitHub. A pull request that edits the file is reviewed using the configuration at its merge base. Later reviews can use the changes after they merge.

For dependencies between separate repositories, record their roles in a repository cluster. Architecture layer paths belong to a single repository.

Search help

Tab to a result. Enter to open. Escape to close.