From d0add46e45c5d980107e852ade1beab19ba6bc8a Mon Sep 17 00:00:00 2001 From: Derek Gulbranson Date: Wed, 1 Jul 2026 18:12:50 -0700 Subject: [PATCH] docs: add CITATION.cff for GitHub 'Cite this repository' (#118) Adds machine-readable citation metadata so GitHub surfaces a 'Cite this repository' button and downstream users get a consistent format. Also notes in the release checklist to bump the CITATION.cff version alongside _version.py. Co-Authored-By: Claude Opus 4.8 --- AGENTS.md | 2 +- CITATION.cff | 12 ++++++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 CITATION.cff diff --git a/AGENTS.md b/AGENTS.md index 24a777e..d491280 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -45,7 +45,7 @@ uv run sphinx-build -b html docs dist/docs # 0. Review docs/ for anything stale — especially usage.rst (examples, API surface) # and any .rst files that reference config constants or HumanName kwargs # Also review AGENTS.md for stale commands, architecture notes, or gotchas -# 1. Bump VERSION in nameparser/_version.py +# 1. Bump VERSION in nameparser/_version.py (and the `version:` field in CITATION.cff to match) # 2. Stamp "Unreleased" → "X.Y.Z - Month DD, YYYY" in docs/release_log.rst # 3. git commit + git tag -a vX.Y.Z -m "Release X.Y.Z" # 4. git push origin master && git push origin vX.Y.Z ← tag must be pushed separately before gh release create diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..2f540a2 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,12 @@ +cff-version: 1.2.0 +message: "If you use this software, please cite it as below." +title: python-nameparser +abstract: "A simple Python module for parsing human names into their individual components." +type: software +authors: + - family-names: Gulbranson + given-names: Derek +repository-code: "https://github.com/derek73/python-nameparser" +url: "https://github.com/derek73/python-nameparser" +license: LGPL-2.1-or-later +version: "1.2.1"