Skip to content

Release notes and test names cite a private review numbering that collides with real GitHub issue numbers #32

Closed

Description

@jacobyoby

What

The manifest ReleaseNotes and several Pester Describe blocks refer to issues by number, using an internal code-review list that has nothing to do with this repository's issue tracker:

  • Describe 'Get-SnmpNeighbors node eligibility (#1 regression)'
  • Describe 'Invoke-SnmpWalk parameter validation (#6 regression)'
  • Describe 'Invoke-PortScan parameter validation (#7 regression)'
  • Describe 'Export-DrawIO duplicate-IP handling (#8 regression)'
  • Describe 'Export-DrawIO subnet container parenting (#9 regression)'
  • Describe 'Quick-start wizard CIDR math (#4 regression)'

GitHub issue #9 in this repository is "Wizard overwrites the diagram with the inventory JSON when -OutputPath does not end in .drawio", which is unrelated to subnet container parenting. Anyone following the reference lands on the wrong ticket. GitHub also auto-links #9 in the manifest text wherever it is rendered.

Why it matters for 1.0

A test named after a regression is documentation of why the test exists. When the pointer is wrong, the test looks like it guards something it does not, and a future contributor deleting it will believe they checked.

Done when

  • Test names describe the behaviour without a bare #n, or cite the real GitHub issue where one exists.
  • Manifest ReleaseNotes drop the #n references or link them fully.
  • If the private review list is worth keeping, it lives in a file in the repository that the numbers can point at.

Activity

  1. added this to the 1.0 milestone on Sep 8, 2026
  2. jacobyoby commented on Sep 9, 2026

    @jacobyoby
    OwnerAuthor

    Fixed in e98b85c: removed private #1/#4/#6/#7/#8/#9 review numbering from Describe names; kept real issue refs (#10, #13, #15, #17, #19, #20, #27, #34). Manifest ReleaseNotes has no bare #n.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions