8000 process: keep data-integrity bugs visible until the fix ships in a release · Issue #399 · project-minigraf/minigraf · GitHub
[go: up one dir, main page]

Skip to content

process: keep data-integrity bugs visible until the fix ships in a release #399

Closed

Description

@adityamukho

Problem

#287 and #371 were closed as "completed" when #377 merged. That fix was then moved from main to the v3 branch (#378), so every v2.x release still has the bug. Anyone who reads the open issues to judge risk will not see it. The CHANGELOG "Known issues" section is correct, but people rarely read it before adopting.

Ask

  • Rule: an issue in data-integrity, corruption or durability stays open until its fix is in a published release. Link the release in the closing comment.
  • Add a known-issue label, and a pinned "Known issues in the current release" issue that lists each bug with its affected versions, workaround and fix version.
  • Add a short "Known issues" section near the top of the README that links to the pinned issue.
  • For bugs found by users downstream, add the affected version range to the issue title or body.

#371 has been reopened under this rule.

Metadata

Metadata

Assignees

No one assigned

    Labels

    data-integrityData integrity issuedocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      0