Edirom-Online icon indicating copy to clipboard operation
Edirom-Online copied to clipboard

Improve citability

Open roewenstrunk opened this issue 8 years ago • 3 comments

The Release should be citable as decribed here: https://guides.github.com/activities/citable-code/

roewenstrunk avatar Aug 02 '17 12:08 roewenstrunk

https://citation-file-format.github.io

bwbohl avatar Feb 09 '22 14:02 bwbohl

fetch contributor names over github api

bwbohl avatar Feb 09 '22 14:02 bwbohl

The GitHub repo is archived and published through Zenodo at 10.5281/zenodo.5347861. This is a good start, nonetheless I think there is room for improvement:

  • [x] Add the all version DOI to README
  • [x] Add the release-specific DOIs to all Releases published at Zenodo
  • [x] Improve the metadata of the Zenodo publications (maybe a CFF file as mentioned above might help)
  • [ ] Add build artifacts to the Zenodo publications
  • [x] Add a citation proposal for citation of unreleased branches

bwbohl avatar Sep 05 '24 06:09 bwbohl

fetch contributor names over github api

https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#list-repository-contributors

daniel-jettka avatar Oct 24 '24 12:10 daniel-jettka

* [ ]   Add a citation proposal for citation of unreleased branches

Adding a citation section to README which says one shall add the commit hash to the citation... not sure if that's sufficient

daniel-jettka avatar Nov 01 '24 14:11 daniel-jettka

* [ ]  Add the release-specific DOIs to all Releases published at Zenodo

Isn't that fulfilled by default? All versions with DOIs are listed on right hand side in Zenodo:

image

daniel-jettka avatar Nov 01 '24 14:11 daniel-jettka

* [ ]  Add build artifacts to the Zenodo publications

How?

daniel-jettka avatar Nov 01 '24 14:11 daniel-jettka

ping @bwbohl :-)

daniel-jettka avatar Nov 13 '24 16:11 daniel-jettka

separate issue for Zenodo problem / features moved to: #475

We will create a pull request for the present issue now.

daniel-jettka avatar Nov 21 '24 10:11 daniel-jettka

* [ ]  Add build artifacts to the Zenodo publications

How?

For 1.0.0-beta.6 the xar was added manually because the complete publication in Zenodo was manually https://zenodo.org/records/14196509

daniel-jettka avatar Nov 21 '24 10:11 daniel-jettka

* [ ]  Add the release-specific DOIs to all Releases published at Zenodo

Isn't that fulfilled by default? All versions with DOIs are listed on right hand side in Zenodo:

image

I didn’t mean on Zenodo but either in the Release description and/or in the code, e.g., in the About window or in the expath-pkg.xml (don’t know if thats possible) or at least in some version.txt in the package.

bwbohl avatar Dec 19 '24 14:12 bwbohl