Plain-English header: what this file does to your machine - #38
Open
davidcrowe wants to merge 1 commit into
Open
davidcrowe wants to merge 1 commit into
davidcrowe wants to merge 1 commit into
Conversation
Addressed to the person whose home directory this lands in, not to a developer. Every sentence names the function that makes it true, and a structural test asserts each cited function still exists, so the header cannot rot silently. Prompted by a user whose agent spent two minutes reading this file at four offsets and grepping it for fetch( and process.exit to answer three questions — what leaves my machine, can this block me, what runs at session start — before uninstalling. Those answers now sit on the first screen.
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.
A header addressed to the person whose home directory this file lands in — what leaves the machine and to which host, what happens when the gateway is unreachable (interactive fails open, unattended fails closed), what runs at session start, whether it can block or rewrite a call, and how to remove it. Every sentence names the function that makes it true;
test/plain-english-header.test.mjsasserts each cited function still exists so the header cannot rot.Prompted by a user whose agent spent two minutes reading this file at four offsets to answer exactly those questions, then uninstalled.
🤖 Generated with Claude Code