Skip to content

Commit 4f1afc8

Browse files
derek73claude
andcommitted
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 <noreply@anthropic.com>
1 parent 001242c commit 4f1afc8

2 files changed

Lines changed: 13 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ uv run sphinx-build -b html docs dist/docs
4545
# 0. Review docs/ for anything stale — especially usage.rst (examples, API surface)
4646
# and any .rst files that reference config constants or HumanName kwargs
4747
# Also review AGENTS.md for stale commands, architecture notes, or gotchas
48-
# 1. Bump VERSION in nameparser/_version.py
48+
# 1. Bump VERSION in nameparser/_version.py (and the `version:` field in CITATION.cff to match)
4949
# 2. Stamp "Unreleased" → "X.Y.Z - Month DD, YYYY" in docs/release_log.rst
5050
# 3. git commit + git tag -a vX.Y.Z -m "Release X.Y.Z"
5151
# 4. git push origin master && git push origin vX.Y.Z ← tag must be pushed separately before gh release create

CITATION.cff

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
cff-version: 1.2.0
2+
message: "If you use this software, please cite it as below."
3+
title: python-nameparser
4+
abstract: "A simple Python module for parsing human names into their individual components."
5+
type: software
6+
authors:
7+
- family-names: Gulbranson
8+
given-names: Derek
9+
repository-code: "https://github.com/derek73/python-nameparser"
10+
url: "https://github.com/derek73/python-nameparser"
11+
license: LGPL-2.1-or-later
12+
version: "1.2.1"

0 commit comments

Comments
 (0)