doc: document how to reference killed mutant #36900

pull brunoerg wants to merge 1 commits into bitcoin:master from brunoerg:2026-11-doc-devnotes-mutation changing 1 files +35 −0
  1. brunoerg commented at 1:17 PM on November 17, 2026: contributor

    Seeking Concept ACK

    This adds a note on doc/developer-notes.md clarifying how should be the description when a test is added or extended to kill mutants. The main motivation is to facilitate review, avoid duplicated work (different PRs addressing the same mutants), and go towards an automated setup to check it.

  2. DrahtBot added the label Docs on Nov 17, 2026
  3. DrahtBot commented at 1:17 PM on November 17, 2026: contributor

    <!--e57a25ab6845829454e8d69fc972939a-->

    The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

    <!--006a51241073e994b41acfe9ec718e94-->

    External sites

    <!--021abf342d371248e50ceaed478a90ca-->

    Reviews

    See the guideline and AI policy for information on the review process.

    Type Reviewers
    ACK mercie-ux, danielabrozzoni
    Concept ACK Conradgabe
    Stale ACK w0xlt

    If your review is incorrectly listed, please copy-paste <code>&lt;!--meta-tag:bot-skip--&gt;</code> into the comment that the bot should ignore.

    <!--5faf32d7da4f0f540f40219e4f7537a3-->

  4. Conradgabe commented at 3:14 PM on November 17, 2026: contributor

    Concept ACK 6fda4bec3d87a31116eee6b08243cae0f0f1e3f7

  5. danielabrozzoni approved
  6. danielabrozzoni commented at 5:39 PM on November 17, 2026: member

    ACK 6fda4bec3d87a31116eee6b08243cae0f0f1e3f7

  7. mercie-ux commented at 5:47 PM on November 17, 2026: contributor

    ACK 6fda4be

  8. in doc/developer-notes.md:699 in 6fda4bec3d outdated
     693 | @@ -694,6 +694,34 @@ Test placement depends on existing coverage and the type of change:
     694 |    Remove the comments when updating those assertions in the behavior-changing
     695 |    commit.
     696 |  
     697 | +### Tests Targeting Surviving Mutants
     698 | +
     699 | +When a test is added or extended to kill a mutant that survived
    


    maflcko commented at 6:00 PM on November 17, 2026:

    Should this say something about the scope/goal? There are probably 10k-100k mutants for code (e.g. nicer error messages for users), where it is fine to have the code, but the fallback still works and it is probably not worth to have a test for it? E.g. https://github.com/bitcoin/bitcoin/pull/36899/changes


    brunoerg commented at 6:09 PM on November 17, 2026:

    We could say that not every mutant is supposed to be killed, many of them are equivalent or unproductive (e.g. mutating log stuff), and people are encouraged to first submit to mutanthub before writing tests (then we can point as useful or not useful). What do you think?


    brunoerg commented at 7:32 PM on November 17, 2026:

    Done

  9. w0xlt commented at 7:29 PM on November 17, 2026: contributor

    ACK 6fda4bec3d87a31116eee6b08243cae0f0f1e3f7

  10. doc: document how to reference killed mutant 3b46919fd5
  11. brunoerg force-pushed on Nov 17, 2026
  12. brunoerg commented at 7:33 PM on November 17, 2026: contributor

    Force-pushed addressing #36900 (review)

  13. mercie-ux commented at 8:11 PM on November 17, 2026: contributor

    re-ACK 3b46919

  14. DrahtBot requested review from danielabrozzoni on Nov 17, 2026
  15. DrahtBot requested review from w0xlt on Nov 17, 2026
  16. danielabrozzoni approved
  17. danielabrozzoni commented at 9:41 PM on November 17, 2026: member

    reACK 3b46919fd57671094ae03e34d0b3d8350e819e5e


github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-11-19 19:51 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me