docs: require that only source is tracked - #23
Merged
Conversation
osapi tracked netplanStatus.txt — netplan output containing the machine's MAC addresses, a routable IPv6 address, LAN subnets, and its local bridge topology. Nothing in the corpus covered it, so nothing would have caught it. The .just/ half of that cleanup was already covered: the justfiles capability says fetched files are excluded from version control. This adds the missing half. Include the trap both cases share — an ignore rule has no effect on a file that is already committed, so the file must also be untracked. That is the third time this pattern has appeared, after the bun.lock rules and the .just/remote rule. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
Thank you for contributing to this project! 😊🕹️ |
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.
Why
osapi-io/osapi#436 removes two tracked files. Only one of them violated an
existing requirement:
netplanStatus.txtwasnetplan statusredirected to a file and committed inApril — MAC addresses, a routable global IPv6, LAN subnets, and the local
k3s/flannel/CNI and LXD bridge topology. Nothing would have flagged it, because
no requirement said a repository tracks only its own source.
Change
A repository tracks only source, configuration, and documentation — not command
output, not build-time fetched artifacts, not data describing a particular
machine.
Plus the trap all these share, as its own scenario:
That is the third time this pattern has appeared in this standardization:
docs/bun.lockinosapi— ignored and tracked, so the rule was inertdocs/bun.lockinosapi-orchestrator— same.just/remote/react.mod.justinosapi— sameEach looked like policy while doing nothing. Recording it as a scenario means
the next one is a spec violation rather than a discovery.
Scope
repo-standardsrather thango-library-standards, because it binds everyrepository regardless of toolchain.
🤖 Generated with Claude Code