Add the documents an outside contributor needs - #1
Merged
Merged
Conversation
The repository asks for contributions but never said what it wants from them, which for a project this opinionated is the expensive gap: the gist refuses a long list of features, and someone can only find that out by having a pull request declined. CONTRIBUTING.md leads with the governing test - does this make reading and understanding code better - and then states plainly what will be declined and why, so that conversation happens before the code is written rather than after. It also records the two things CI cannot check: stylus feel, and whether ink stays welded to the text while scrolling. CODEOWNERS routes review by blast radius rather than by file count. The gist and the plan are direction, not implementation. Anchoring decides where somebody's handwriting ends up. Workflows and lockfiles can publish to the live site. SECURITY.md sends reports to a private advisory instead of a public issue, and describes where the risk actually is: no backend, no accounts, no token, and code that is rendered but never executed. The surface worth probing is the untrusted repository content the app renders.
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.
What this changes
Adds
CONTRIBUTING.md,.github/CODEOWNERS,.github/pull_request_template.mdandSECURITY.md, and links the first two from the README alongside a local-setup block.Does it make reading and understanding code better?
Indirectly — it protects the product that does. The gist refuses a long list of features, and right now the only way a contributor discovers that is by having a pull request declined after writing it.
How it was tested
npm run typechecknpm testnpm run buildDocumentation only; no source files touched. This PR is also the first end-to-end exercise of the new
mainruleset — requiredverifycheck, linear history, squash or rebase only.Anything reviewers should look at closely
IMPLEMENTATION_PLAN.md§13. Worth checking it matches what you actually intend to refuse.