Pull Request Checks

Understand how SyntaxValid pull request checks report analysis results and enforce merge safety directly in GitHub.

## Pull Request Checks

Pull request checks bring SyntaxValid analysis results directly into GitHub.

They provide a clear, enforceable signal that helps teams decide whether a change is safe to merge.

---

## What a pull request check shows

Each pull request check includes:

- Analysis status (running, completed, failed)

- Blocking or non-blocking result

- TrustScore impact

- Summary of detected issues

Checks are always tied to a specific commit or pull request.

---

## Check states and meanings

### Running

Analysis is in progress.

Results are not final.

### Passed

No blocking issues were found.

The pull request meets the active policy.

### Failed

One or more blocking issues exist.

The pull request does not meet merge requirements.

---

## Blocking behavior

When a check fails:

- Blocking issues are listed

- Merge readiness is denied

- TrustScore reflects unresolved risk

Blocking checks prevent unsafe merges by default.

---

## TrustScore visibility in pull requests

TrustScore helps reviewers:

- Understand overall risk at a glance

- See how the change affects project health

- Prioritize review attention

TrustScore complements issue-level detail.

---

## How reviewers should use checks

### For developers

- Address blocking issues before requesting review

- Use Fix with AI to generate safe patches

- Re-run analysis after fixes

### For reviewers and tech leads

- Use check status as a merge gate

- Focus review effort on blocking findings

- Avoid subjective risk decisions

---

## Policies and checks

Pull request checks reflect the active policy.

If policies change:

- Future checks follow the new rules

- Past results remain traceable

- Enforcement remains consistent

Checks enforce policy, not opinions.

---

## Common questions

### Can checks be bypassed?

Bypass depends on GitHub repository settings.

SyntaxValid respects GitHub’s permission model.

### Do checks modify code?

No.

Checks only report analysis results.

### Do checks run automatically?

Yes.

Checks are triggered by pull request events.

---

## Best practices

- Treat failed checks as merge blockers

- Keep policies realistic and balanced

- Use diff analysis for fast feedback

- Review TrustScore trends over time

---

## Next steps

- IDE integrations

- CI usage options

- Using SyntaxValid in team workflows