dguest / pandamonium

Command line scripts to parse panda web api
BSD 3-Clause "New" or "Revised" License
27 stars 17 forks source link

docs: Add Zenodo metadata file #42

Closed matthewfeickert closed 4 years ago

matthewfeickert commented 4 years ago

This PR enforces a standard for the Zenodo metadata and makes the resulting DOI entry much nicer — the authors listed additionally have their ORCID listed on the Zenodo DOI entry. c.f. pyhf's DOI for an example: DOI

Suggested squash and merge commit message:

* Add .zenodo.json to control metadata for releases on Zenodo
* Control .zenodo.json with bump2version
* Add Matthew as author
matthewfeickert commented 4 years ago

I'm not going to merge this unless you add yourself.

I think that's overly generous of you, but done and thanks.

dguest commented 4 years ago

Actually, one comment: the old record also lists Lawrence Lee; Alex Armstrong; Giordon Stark. I don't think they count as maintainers so we don't have to put them everywhere, but my inclination is to add people who did anything early on to the "creators" field since that gives them a small chance of some kind of indirect credit via the computer bot web.

I like giving people credit via the indirect computer bot web, even if all they did is make a pull request that's more than almost any software user does.

matthewfeickert commented 4 years ago

I like giving people credit via the indirect computer bot web, even if all they did is make a pull request that's more than almost any software user does.

@dguest Yeah, this is one of the things that gets tricky to some extent. They're always be on the older Zenodo archives (as they're archives) but it gets a bit confusing if you're trying to use a Zenodo citation and there's many people attached to know who to actually cite in addition to the "et al.".

One way that people on Scikit-HEP are starting to do this is with making it explicit what people did in the Acknowledgements section of the README and then keeping the dev team as the creators and maintainers on PyPI and Zenodo.