release: v0.3.1

[random-walks]

v0.3.1 release

Patch release. Surfaces the PyPI page polish from #9 to PyPI users.

Fixed — PyPI page rendering

Cover image and ~30 inline links in the README pointed at relative paths (e.g. benchmarks/findings/figures/cover-annotated.png, docs/reference/architecture.md, examples/01_quickstart_mock.py). PyPI does not rewrite relative paths in long-description markdown, so the cover image returned 404 on the project page and every relative link was a dead click. All image srcs are now absolute raw.githubusercontent.com URLs; code/test/script links point to github.com/.../blob/main/...; doc content already mirrored on Read the Docs (architecture, contracts, ADRs) points to citeformer.readthedocs.io/en/stable/... with anchors verified against rendered HTML.

Added — CITATION.cff

New CITATION.cff at repo root (CFF schema 1.2.0). Validates with cffconvert --validate. Enables GitHub's "Cite this repository" widget and BibTeX/APA exports — appropriate for an academic-shaped library that ships a PREPRINT.md. The /bump slash-command is extended to keep version + date-released in CITATION.cff in lockstep with _version.py + CHANGELOG.md, so the three release-stamped files cannot drift via the slash-command path.

Changed — codecov upload reliability

.github/workflows/ci.yml: bump codecov/codecov-action v4 → v5, require CODECOV_TOKEN (now set as a repo secret), drop the continue-on-error: true masking, and flip fail_ci_if_error to true. Coverage upload failures are now visible instead of silently swallowed; the codecov badge flips from "unknown" to a percentage on the next clean run.

Tag

v0.3.1 annotated tag is committed locally — push it after this PR merges to trigger the release workflow:

git push origin v0.3.1

Invariant touched?

No. None of the three §10 contracts are affected. README copy + CI config + new metadata file + slash-command bookkeeping.

Test plan

• make lint — ruff + mypy strict pass
• make test — 644 passed
• make docs-build — Sphinx -W passes
• uv build — sdist + wheel build clean
• cffconvert --validate -i CITATION.cff — valid 1.2.0
• citeformer.__version__ == "0.3.1"
• Merge → push tag → release workflow uploads to PyPI
• Visit https://pypi.org/project/citeformer/ post-release; confirm cover image renders, links resolve

🤖 Generated with Claude Code

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!