docs: add NOTICE, CONTRIBUTING, SECURITY, CODE_OF_CONDUCT; reorganize Readme navigation - #180
Open
yaroslavaristov wants to merge 6 commits into
Open
Conversation
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
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
Adds standard OSS project documentation that was missing:
copyright holder (Niall Douglas, 2015-2026) confirmed across
include//src/file headers; no bundled third-party code requiringseparate attribution.
develop, notmaster), build/test commands fromBuild.md/AGENTS.md, code stylenotes.
instead of public issues, with a scope section tailored to this project
(memory safety, TOCTOU/race-free guarantees, path handling).
Readme.md changes
Also reorganized
Readme.mdnavigation, since the current badge table washard to read (CI badges squeezed between text links in one row):
contents, since the document is long (~200 lines, ~10 sections).
##headers to sections that only had implicit ones (e.g."Why you might need LLFIO"), so the TOC has real anchors to link to.
This last part is more opinionated than the docs additions above, so happy
to split it into a separate PR or drop it entirely if you'd rather keep the
existing Readme structure — let me know.
Why
Wanted to contribute something useful after using LLFIO — these are the
standard files most active OSS repos have and this one didn't yet.