fleetlint Policy for a fleet of repositories
v0.9
Getting started

deps/forks-documented

Forked or patched dependencies are documented

A capability: each stack checks it with its own tools. Implemented for go, node, php, python, ruby, rust.

Combine: all. Every implementation that runs must pass: each stack in the repository meets the requirement with its own tools.

Severityinfo
Tiers1, 2
Stacksany
Scoperoot
Kindcapability
Sourcelibrary v0.6.0
Selected byfleetlint-recommended@v0.6.0

Requirement

Every dependency taken from a fork or a git source is documented: upstream, base version, what changed and why. A FORKS.md (root or docs/), a Forks section in the README or docs, or an inline comment on the line where the manifest has comments counts. Each stack’s implementation says which manifest lines are forks.

Why

A fork without a note outlives the reason for it; the next upgrade either drops the fix or keeps the fork forever.

Fix

Add docs/FORKS.md listing each forked or patched dependency with upstream, base version, the change and why, or comment each line.

Agent instruction: Document each forked or patched dependency (upstream, base version, change, reason) in docs/FORKS.md; ask the user for the reason where the history does not say.

Sources


Generated by fleetlint docs from catalog v0.6.0.