Choose which code checks and comments appear in reviews

Use the organization's Code review settings to configure code findings and their GitHub presentation, then inspect overrides for repositories with different needs.

Configure code checks and comments#

In the organization's Code review settings, Enable code reviews enables the code review alongside environment assessments. Flag disabled and focused tests and Flag debug residue apply where code review runs.

Review maintainability and quality checks unnecessary complexity, implicit assumptions, duplicated responsibilities and verification gaps introduced or worsened by a change. It is off by default. Enable it in the organization's Code review settings, or choose On for this repository, Off for this repository, or Same as the organization under a repository's Maintainability and quality setting. Save the review settings to apply the choice to new assessments. Reviews already admitted keep their choice.

Simplification candidates cite source, name a concrete maintenance cost and suggest a smaller alternative. They stay distinct from runtime defects. Style preferences and unsupported concerns are excluded. The checks use the code review's existing model and budget.

Flag stale doc comments reports a doc comment that the pull request leaves unchanged and that still documents a parameter the change removed from a public Python, JavaScript, TypeScript, Java or Rust function or method. Doc comments in other languages are not assessed. While the setting is on, a change that removes lines from a Go file leaves code review incomplete. So does a doc comment that documents parameters of a form the review does not compare, such as a TypeScript namespace member, a Java overload or a method of a Rust trait implementation. The Check then says Proofline could not finish this review. The review that View review details opens says Review incomplete and that the code review could not read everything it needed. Neither names the cause. It applies to reviews that start after you save it, and earlier reviews keep their results. Each repository's Code review page can follow the organization or turn it on or off.

Strictness sets how many findings become inline comments: Low posts fewer and High posts more. The Inline comment limit follows the strictness level unless you choose Set a limit, and Follow the strictness level returns to it. Additional findings remain on the Check. A review keeps the strictness and limit it started with. Each repository's Code review page can follow the organization or set its own strictness and limit. A strictness in the repository's .proofline.yaml file replaces both settings for reviews that read the file. A completed code review does not complete an environment assessment.

Search help

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