Put the public-tree rule where a contributor meets it - #8
Merged
Merged
Conversation
The rule that this tree is read by strangers lived only in the working instructions, which are deliberately not committed, so it reached nobody who cloned. It now opens docs/architecture.md, before the overview, because it governs every section below it: a rule met after 600 lines is a rule met too late. It states what a contributor must obey and nothing else. Write for a reader who knows nothing about another project; a push cannot be recalled, because an object stays fetchable by its hash after a force-push; and test fixtures are the usual leak rather than the obvious secrets, so invented names must still preserve the property under test. The same rule covers assets/, which is why the screenshots are taken against the workspace make demo builds. Closes backlog item 12, which was open on a decision rather than on work: how much of the uncommitted instructions belong in the published tree. The answer drawn here is the rule, never the measurement.
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.
Backlog item 12. The rule that this tree is read by strangers lived only in the uncommitted working instructions, so it reached nobody who cloned.
It now opens
docs/architecture.md, before the overview, because it governs every section below it.Documentation only. No code touched.