Skip to content

docs: add NOTICE, CONTRIBUTING, SECURITY, CODE_OF_CONDUCT; reorganize Readme navigation - #180

Open
yaroslavaristov wants to merge 6 commits into
ned14:developfrom
yaroslavaristov:docs/add-notice-contributing-security
Open

docs: add NOTICE, CONTRIBUTING, SECURITY, CODE_OF_CONDUCT; reorganize Readme navigation#180
yaroslavaristov wants to merge 6 commits into
ned14:developfrom
yaroslavaristov:docs/add-notice-contributing-security

Conversation

@yaroslavaristov

Copy link
Copy Markdown

What

Adds standard OSS project documentation that was missing:

  • NOTICE — attribution file per Apache License 2.0 §4(d). Single
    copyright holder (Niall Douglas, 2015-2026) confirmed across
    include//src/ file headers; no bundled third-party code requiring
    separate attribution.
  • CONTRIBUTING.md — fork/branch/PR workflow (based on develop, not
    master), build/test commands from Build.md/AGENTS.md, code style
    notes.
  • SECURITY.md — points to GitHub's private vulnerability reporting
    instead of public issues, with a scope section tailored to this project
    (memory safety, TOCTOU/race-free guarantees, path handling).
  • CODE_OF_CONDUCT.md — Contributor Covenant 2.1.

Readme.md changes

Also reorganized Readme.md navigation, since the current badge table was
hard to read (CI badges squeezed between text links in one row):

  • Split into a badges/title block (shields.io style) + a short table of
    contents, since the document is long (~200 lines, ~10 sections).
  • Added explicit ## headers to sections that only had implicit ones (e.g.
    "Why you might need LLFIO"), so the TOC has real anchors to link to.
  • No content was removed or reworded — only structure/navigation.

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.

Copilot AI lite review requested due to automatic review settings August 19, 2026 11:37

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants