Skip to content

docs: sketch the policy file reference #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Herricka wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: sketch the policy file reference #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/policy-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Policy file reference (sketch)

A proposal for discussion, not a finished page.

## Shape

version: 1
thresholds:
coverage: 0.80
repetition: 0.35
rules:
- name: max-function-length
limit: 60
severity: warn
- name: error-returns-context
severity: error

## Open questions

- Should `severity: warn` be able to fail a gate, or only `error`?
- Do we allow per-repository overrides, or is a policy file always repo-local?
- What is the exit code for a policy that fails to parse, as opposed to one that runs?
Loading