Add CITATION.cff and a code of conduct - #338
vahid-ahmadi wants to merge 1 commit into
Conversation
Split out of #315 at Max's request. Both are useful without a paper: the Zenodo concept DOI 10.5281/zenodo.22829459 already makes the package citable, and CITATION.cff is what GitHub and Zenodo read to render that citation with the right authors and ORCIDs. Version tracks the current release, 1.5.10.
MaxGhenis
left a comment
MaxGhenis
left a comment
There was a problem hiding this comment.
Thanks for splitting these out. Two changes before merge, both in CITATION.cff.
The version-specific DOI is for 1.5.9, but version says 1.5.10
version: 1.5.10 sits next to 10.5281/zenodo.22831047, described as "Archived version 1.5.9". Zenodo's record 22831047 is v1.5.9. The v1.5.10 archive is 10.5281/zenodo.22833006.
Suggest dropping version and the version-specific identifier and keeping only the concept DOI. Both fields go stale at every release. The concept DOI always resolves to the latest archive, and Zenodo records the version on each archive itself. If you'd rather keep them, update the DOI to 22833006 and add a release-checklist step to bump both.
The abstract says "Foster-Greer-Thorbecke poverty measures"
Of the five poverty methods, only poverty_rate is an FGT index. poverty_gap and deep_poverty_gap return aggregate gaps in currency units, and squared_poverty_gap returns an aggregate in currency squared. #334 documents this, and #336 rewrites the docstrings to match. Suggest "poverty headcount rates and aggregate poverty gaps" in place of "Foster-Greer-Thorbecke poverty measures".
Checked and fine
cffconvert --validate: valid against schema 1.2.0.- The concept DOI 10.5281/zenodo.22829459 resolves, and the Zenodo concept record holds v1.5.5, v1.5.8, v1.5.9 and v1.5.10.
- All four ORCIDs resolve to the named authors (Vahid Ahmadi, Max Ghenis, María Juaristi, Nikhil Woodruff).
- The code of conduct is Contributor Covenant 2.0, with a real contact address and attribution.
- CI is green and the branch merges cleanly.
This branch has not been deployed
2 participants
Split out of #315, per @MaxGhenis's request there. Both files are useful whether or not a paper is submitted.
CITATION.cff— validates against schema 1.2.0, lists all four authors with ORCIDs, and carries the Zenodo concept DOI10.5281/zenodo.22829459alongside the version-specific one. GitHub renders a "Cite this repository" button from it and Zenodo reads it at release, so the package cites correctly without a paper. Version updated to 1.5.10 to match the current release.CODE_OF_CONDUCT.md— Contributor Covenant with a real contact address.paper.md,paper.bibanddraft-pdf.ymlstay in thejoss-paperbranch history.