A tool for updating / revising / extending CITATION.cff

[Ly0n]

Relates to: https://github.com/protontypes/open-sustainable-technology/issues/199 As discussed in the last OST meeting, this project is a better fit for ecosyste.ms as multiple services from this platform are needed.

OST is still very interested in supporting this as a test case, as this would create more incentives for people contributing. Personally, I would also like to gain some basic Ruby experience on this project so that I can help maintain it in the future. However, for the basic design of this tool it makes more sense to build on the experience of ecosyste.ms.

[andrew]

I've moved this over into the roadmap repo as it isn't OST specific.

Some of the steps to implement off the top of my head:

• fetch details of the repository (from https://repos.ecosyste.ms/)
• fetch all of the committers to a project (can be done with https://commits.ecosyste.ms)
• enrich committer data by looking up their ORCID (https://info.orcid.org/documentation/api-tutorials/api-tutorial-searching-the-orcid-registry/)
• output a citation.cff file (using https://github.com/citation-file-format/ruby-cff)
• optional: threshold for number of commits to be included
• optional: include issue/pr contributors (data from https://issues.ecosyste.ms/)

[RichardLitt]

Looks like a good initial roadmap, to me. I would also look for any citation data in their READMEs.

[Ly0n]

Here's what comes to mind spontaneously.

1. I would recommend creating a very small website with its own domain, including a short why/abort section.
2. The output should have a copy/paste button and a download CITATION.cff.
3. The user should be able to chose between rewrite and extend.
4. Committers should also include those listed in CONTRIBUTORS.md in the long term.