Skip to content

docs: add CITATION.cff for academic citation support#829

Merged
bosd merged 1 commit into
camelot-dev:masterfrom
Mohataseem89:add--citation-cff
Jul 18, 2026
Merged

docs: add CITATION.cff for academic citation support#829
bosd merged 1 commit into
camelot-dev:masterfrom
Mohataseem89:add--citation-cff

Conversation

@Mohataseem89

Copy link
Copy Markdown
Contributor

Adds a CITATION.cff file to the repository root so that users who want to cite Camelot in academic papers or research have a standard, machine-readable reference. GitHub natively detects this file and adds a "Cite this repository" button to the sidebar automatically.

Fixes: #818

@bosd

bosd commented Jul 18, 2026

Copy link
Copy Markdown
Collaborator

Reviewed — this looks good: valid CFF 1.2.0, correct author/license/version metadata, and a nice descriptive abstract + keywords. It'll give the repo a native "Cite this repository" button once merged.

The only red check is codecov/project (the project-coverage delta gate) — expected and irrelevant here, since a CITATION.cff adds no code. Everything substantive (pre-commit, tests across 3.10–3.15 + Windows/macOS, docs-build, codecov/patch) is green.

Thanks @Mohataseem89 — one small optional nice-to-have would be adding a second author line - name: "The Camelot contributors", but it's fine as-is.

@bosd
bosd merged commit 595b3b4 into camelot-dev:master Jul 18, 2026
17 of 18 checks passed
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.

Prefered way to cite Camelot?

2 participants