Repository navigation
docs(learnings): name slot occupancy as its own rule - #28
Merged
Merged
Conversation
It was already in the entry, buried in a list of things to check. Its failure mode deserves to be legible on its own: reachability answers whether your control would run, occupancy answers what you would be replacing, and the two are different commands. Here the slot held ggshield's secret scan, so writing into it would have displaced a working guard while reading as installed — silent, and the file looks right. See CHANGELOG [Unreleased] > Changed.
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.
One paragraph, promoted out of a list.
The lesson was already recorded — whether the slot is already occupied sat as the third item in a four-item checklist. Its failure mode deserves better than that position.
Reachability and occupancy are different questions, answered by different commands. Reachability says whether your control would run. Occupancy says what you would be replacing. Stopping at the first is how you miss the second: here the
pre-commitslot heldggshield's secret scan, so writing into it would not merely have been dead — it would have displaced a working guard while reading as installed. Silent, and the file looks right, which is the worst class this repository keeps meeting.The occupancy was found only because the next step happened to be look at the place you are about to write. Nobody went looking for it, which is exactly why it is worth writing down.