public/contributing
Public repository explains how to contribute
| Severity | info |
| Tiers | 1 |
| Stacks | any |
| Scope | root |
| Kind | expr |
| Source | library v0.4.0 |
| Selected by | fleetlint-recommended@v0.4.0 |
Requirement
A CONTRIBUTING file exists at the root or in .github/, docs/ or .gitea/. It should state how to set up, run make check, and what a pull request needs; its content is not checked.
Why
It is the difference between a drive-by issue and a merged fix.
Applies when
repo.publicCheck
exists("CONTRIBUTING*") || exists(".github/CONTRIBUTING*") || exists("docs/CONTRIBUTING*") || exists(".gitea/CONTRIBUTING*")Fix
Add CONTRIBUTING.md: setup, make check, commit convention, PR expectations.
Agent instruction: Write CONTRIBUTING.md from the Makefile targets and hook configuration actually present; keep it under one page.
Sources
- https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors (guidance)
- https://fleetlint.org/baseline/#public-repositories
Generated by fleetlint docs from catalog v0.4.0.