Repository navigation
Replies: 1 comment
|
Turned into an implementation issue: #3438 Decisions: the bundle goes in |
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Problem
Workers find the same things again and again, and what one agent learns stays in its PR, its issue or its own notes. Examples from one day of sanitizer work (#3238):
RTMP_Close(),da_free()of a buffer): test: test_ffmpeg_mux_write_packet leaks its packet buffer (LeakSanitizer, valgrind) #3400, test: test_rtmp_send_batch leaks the RTMP channel packets (LeakSanitizer, valgrind) #3401. Since ci(sanitizers): the asan job fails on what it finds; tsan in a pool; valgrind runs every test, two at a time (follow-up to #3279) #3290, the asan job fails on such a leak.workflow_dispatchofsanitizers.yamlon a PR branch cancels the run that is in progress there (one concurrency group per ref).rust/tools/sanitize/triage.py) has kinds (bug,flaky,tool); abugentry that runs clean fails the job.Each of these cost hours to find. The next worker who writes a timing test or a leak-prone test does not see them.
Proposal
A small knowledge bundle in
docs/knowledge/, in the Open Knowledge Format (OKF, Apache 2.0):type; we would also usetitle,description,sources(the issue, PR or run that shows it),statusandstale_after, so a finding that a decision can change (such as build: C float results depend on the build host's gcc (FMA contraction on the CI runners) #3422) says when to check it again.index.mdthat lists the concepts with their descriptions.OKF is young (v0.2) and has no validator. We would use only its core (frontmatter and
index.md), which a lint check in./lintcan enforce in a few lines: every file has frontmatter, atypeand adescription, and appears inindex.md.How agents find it
A bundle that nothing points to is not read. So:
docs/knowledge/index.mdunder "Mandatory reading", next to testing-policy.md.obs-workerskill link the concepts at the point of use, for example: "before you write a test that waits for frames or audio, readdocs/knowledge/timing-tests.md".What it is not
timingresource lock test, the known list, the asan gate), the check stays the rule, and the concept explains why and links to it.First contents
timinglock.bugentry fails.Questions
docs/knowledge/the right place, or should it go underdocs/rust-port/?All reactions