Skip to content

Add Zenodo DOI badge, citation metadata, and identifiers #325

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
igerber merged 2 commits into from
Apr 18, 2026
Merged

Add Zenodo DOI badge, citation metadata, and identifiers #325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
717c7a0
Add Zenodo DOI badge, citation metadata, and identifiers
igerber Apr 18, 2026
9eac7d6
Address CI review P3: document citation-vs-package authorship split
igerber Apr 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Changed
- Add Zenodo DOI badge to README; upgrade the BibTeX citation block with the concept DOI (`10.5281/zenodo.19646175`) and list author as Isaac Gerber (matching `CITATION.cff`). Add `doi:` and `identifiers:` entries (concept + versioned) to `CITATION.cff`. DOI was minted by Zenodo when v3.1.3 was released.

## [3.1.3] - 2026-04-18

### Added
Expand Down
8 changes: 8 additions & 0 deletions CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ authors:
license: MIT
version: "3.1.3"
date-released: "2026-04-18"
doi: "10.5281/zenodo.19646175"
identifiers:
- type: doi
value: "10.5281/zenodo.19646175"
description: "Concept DOI — always resolves to the latest release"
- type: doi
value: "10.5281/zenodo.19646176"
description: "Versioned DOI for v3.1.3"
url: "https://github.com/igerber/diff-diff"
repository-code: "https://github.com/igerber/diff-diff"
keywords:
Expand Down
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Downloads](https://img.shields.io/pypi/dm/diff-diff.svg)](https://pypi.org/project/diff-diff/)
[![Documentation](https://readthedocs.org/projects/diff-diff/badge/?version=stable)](https://diff-diff.readthedocs.io/en/stable/)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.19646175.svg)](https://doi.org/10.5281/zenodo.19646175)

A Python library for Difference-in-Differences (DiD) causal inference analysis with an sklearn-like API and statsmodels-style outputs.

Expand Down Expand Up @@ -3067,14 +3068,20 @@ If you use diff-diff in your research, please cite it:
```bibtex
@software{diff_diff,
title = {diff-diff: Difference-in-Differences Causal Inference for Python},
author = {{diff-diff contributors}},
author = {Gerber, Isaac},
year = {2026},
url = {https://github.com/igerber/diff-diff},
doi = {10.5281/zenodo.19646175},
license = {MIT},
}
```

The DOI above is the Zenodo concept DOI — it always resolves to the latest release. To cite a specific version, look up its versioned DOI on [the Zenodo project page](https://doi.org/10.5281/zenodo.19646175).

See [`CITATION.cff`](CITATION.cff) for the full citation metadata.

**Note on authorship**: academic citation (`CITATION.cff`, the BibTeX above) lists individual authors with ORCIDs per scholarly convention. Package metadata surfaces (`pyproject.toml`, Sphinx docs) list "diff-diff contributors" to acknowledge the collective — see [`CONTRIBUTORS.md`](CONTRIBUTORS.md) for the full list.

## License

MIT License
Loading