docs: migrate tech-debt.md to GitHub Issues - #47
Merged
Conversation
tech-debt.md had become a merge-conflict hotspot: independent PRs kept appending near the tail of the same file, causing repeated rebase conflicts unrelated to their actual changes. GitHub Issues are inherently global rather than per-branch, so this can't happen again, and closing an issue naturally cross-links to the PR that fixed it. Migrated the 7 still-open entries as issues #39-#45, plus a new open3d CI-coverage-gap issue (#46). Already-resolved entries (gridify IndexError, ncdf deprecation warning, sphinx-codeautolink pin) weren't carried forward -- their history remains in this file's own git log. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Up to standards ✅🟢 Issues
|
2 tasks
petercorke
added a commit
to petercorke/swift
that referenced
this pull request
Aug 3, 2026
tech-debt.md kept causing pure concurrent-insert merge conflicts -- hit three in this session alone landing jhavl#76/jhavl#79/jhavl#80/jhavl#81, none of them related to the actual code change in the branch that triggered it. Same problem hit MVTB, resolved there the same way (see petercorke/machinevision-toolbox-python#47). Every open item moved to a GitHub issue labeled tech-debt: jhavl#82-89 (new open items), jhavl#93 (FUTURE-NO-MICROSERVER.md, same file-clutter problem, folded in too). Already-resolved entries logged as closed issues for a complete searchable record (jhavl#90-92) rather than left to git-log archaeology. The Colab investigation was folded into the existing user-filed jhavl#45 instead of creating a duplicate. Updated ~9 in-code comments/docstrings that referenced tech-debt.md by name to point at the relevant issue instead.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
tech-debt.mdhad become a recurring merge-conflict hotspot -- multiple independent PRs this month each appended near the tail of the same file, causing rebase conflicts unrelated to their actual changes.tech-debt(Histogram.plot's type docstring doesn't match its actual accepted values #39-Repo root is full of untracked scratch/junk files #45), plus logged a new open3d CI-coverage-gap finding as open3d tests exist but have presumably always been skipped in CI #46. Already-resolved entries (gridify IndexError fix, ncdf deprecation warning fix, sphinx-codeautolink pin resolution) weren't carried forward as issues since they're done -- their history remains in this file's own git log.tech-debt.mdto point at thetech-debtlabel instead.Test plan