ropensci / software-review-meta

For organizing projects related to rOpenSci Software Peer Review
10 stars 3 forks source link

Review info in codemeta.json #49

Open maelle opened 6 years ago

maelle commented 6 years ago

@ropensci/editors

For onboarded packages codemeta.json will include review metadata, a minima review URL + rOpenSci as provider.

Now in https://github.com/ropensci/codemetar/issues/23#issue-244508322 @cboettig says "it would be natural to include the review author & editor here too". Technically we could get this information from GitHub (and even have a pre-digested table somewhere on GitHub, not only the private Airtable) but do we want to have reviewers and editor(s) listed in codemeta.json given that we ask reviewers for authorization before including them in DESCRIPTION?

sckott commented 6 years ago

I think it's okay to include them.

karthik commented 6 years ago

I think this could be a checklist item so that we have consent. For editors it would be easy since there are only 4 of us.

maelle commented 6 years ago

Ok so the digested open table would take that into account.

And for past reviews, would we try and contact former reviewers or just not include them?

noamross commented 6 years ago

I sort of think its fine to include them without asking. For DESCRIPTION files, there's a little more implication by including people in the Author: field that they are "participants", even with the 'rev' role. But in codemeta.json, the Review is a separate field. I'd only ask reviewer permission if we were to include additional contact information.

maelle commented 6 years ago

Cool, now I just need to think of how/where to make the digested table Review number, Reviewers, Editor available for everyone.

maelle commented 6 years ago

To be generated from the Airtable to a public csv

Currently the review deduced from an rOpenSci peer-review badge includes only provider and URLs, cf https://github.com/ropensci/codemetar/blob/387456e9d62fdb9be936a089d7173e8d21d783b8/codemeta.json#L451 but with such info it'll include "editor" and "author" (= reviewers), each person will have a name and URL (GitHub profile).

maelle commented 5 years ago

@karthik could you start by making the information you use for the badges available as an API? So that I could query it with an issue number, and it'd return me the status (instead of my asking GitHub API). In the packages/ page I'd like to be able to assign the right badge color without using a badge.

karthik commented 5 years ago

Sure, let me work on that

maelle commented 5 years ago

A csv dump would be just fine, I'd memoise it

karthik commented 5 years ago

Sure, I can also do a json dump if that's easier

maelle commented 5 years ago

as you prefer

maelle commented 5 years ago

@karthik in https://badges.ropensci.org/json/onboarded.json the entry 127 lacks a pkgname. It's googleLanguageR