coderaiser / putout-editor / 36345596550

100%

push

github

docs: agents: say when something is broken, do not wait to be asked

The last month had 84 fix: commits with an empty message body. That is the reason a bug
gets re-derived instead of re-read, and it is the token cost this repository keeps paying
without noticing - the sixth time the same class of problem has turned up here.

So the rule is now in AGENTS.md rather than implied. Notice something broken, slow, or
repeated and file it: a bug as a finding, a pattern as an idea with the count behind it, a
failed approach as a rejected idea with its error. Fixing the thing is the work, recording
it is part of the job, and asking permission to write down what you just learned is the part
to stop doing.

Two entries are called out because they are the ones that keep recurring and the ones a new
contributor cannot be expected to know:

- A check that passes on a cheaper path than the user takes. Compile is not execute,
  find_places is not transform, a plugin's own suite does not lint the repository. Say which
  mode your check exercised.
- A fix: commit with no body. docs says how to write the reasoning; this says to write it.

The measurements behind both are in docs/lessons.md, and docs/ideas.md is where the result
of noticing something goes.

1081 of 1081 branches covered (100.0%)

Branch coverage included in aggregate %.

6663 of 6663 relevant lines covered (100.0%)

61.54 hits per line