Add AI Covenant + CONTRIBUTING; note AI assistance in README - #11
Merged
Conversation
Adopt an AI-use policy modeled on the LinkML AI Covenant, and document how to contribute — in both the repo files and the docs site. - AI_COVENANT.md: adapted from LinkML's, tailored to LOKF. Adds an explicit "No AI co-authorship" rule (Co-Authored-By trailers for an AI are disallowed) and a generated-artifacts clause (edit lokf.yaml + regenerate, never hand-edit — including with an AI). - CONTRIBUTING.md: short root guide (single source of truth, verify with just build/test, reuse public vocabulary) linking the covenant + docs. - web/ docs: new Contributing page (+ sidebar entry) with the full workflow and a Responsible-AI section linking the covenant. - README: an "AI assistance" note — developed with AI (Claude); the author reviews and owns every commit; AI is a tool, not a co-author. README reviewed for correctness: the CLI/API claims match the code (rdf.serialize exists; --format = ttl|nt|jsonld|xml|n3|trig). Docs build clean (22 pages).
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.
Reviews the README for correctness and adopts an AI-use policy modeled on the LinkML AI Covenant, documenting contribution norms in both the repo files and the docs site.
README
Reviewed for correctness — the technical claims match the code (
lokf.rdf.serializeexists; the CLI--formataccepts exactlyttl | nt | jsonld | xml | n3 | trig; the generated-files table and build commands are accurate). Added an AI assistance note: LOKF is developed with AI (Claude), the author reviews and takes full responsibility for every commit, and AI is a tool, not a co-author (never credited in commit messages).New policy + contribution docs
AI_COVENANT.md— adapted from LinkML's, tailored to LOKF. Keeps the core principles (you own your contributions; AI reviews are suggestions; humans own discussions; disclose AI-origin for unfamiliar changes) and adds:Co-Authored-Bytrailers for an AI are disallowed;lokf.yamland regenerate; never hand-edit a generated file, including with an AI.CONTRIBUTING.md(root) — short guide: single source of truth, verify withjust build/just test, reuse public vocabulary, and a pointer to the covenant. Mirrors LinkML's pattern (stub + link to docs + covenant reference).web/docs — a new Contributing page (added to the sidebar) with the full workflow and a "Responsible AI use" section linking the covenant.Docs build clean (22 pages; the
/contributingpage renders). Per the covenant it introduces, this PR has no AI co-author.