Skip to content

CONTRIBUTING present

Tells an outside contributor how to build, test and submit a change before they burn an afternoon guessing.

Gate ID
contributing_present
Severity
info
Scope
Project root
Tags
project-hygiene

What it checks

A CONTRIBUTING.md helps outside contributors know how to set up and submit changes.

Accepted: CONTRIBUTING, CONTRIBUTING.* (any extension).

What a finding says

text
No CONTRIBUTING file at the project root. Document how to build, test, and submit PRs.

Turning it off

Silence the gate for the whole project in .l0git.json:

json
{
  "ignore": ["contributing_present"]
}

Or keep it running at a lower severity:

json
{
  "severity": { "contributing_present": "info" }
}

See also

Released under the MIT License. · Privacy & legal