Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review info in codemeta.json #49

Open
maelle opened this issue Apr 18, 2018 · 12 comments
Open

Review info in codemeta.json #49

maelle opened this issue Apr 18, 2018 · 12 comments

Comments

@maelle
Copy link
Member

maelle commented Apr 18, 2018

@ropensci/editors

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

Now in ropensci/codemetar#23 (comment) @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
Copy link

sckott commented Apr 18, 2018

I think it's okay to include them.

@karthik
Copy link
Member

karthik commented Apr 18, 2018

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
Copy link
Member Author

maelle commented Apr 19, 2018

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
Copy link
Contributor

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
Copy link
Member Author

maelle commented Apr 19, 2018

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

@maelle
Copy link
Member Author

maelle commented Jul 2, 2018

To be generated from the Airtable to a public csv

  • one line by package, or one line by person involved editor/reviewer
  • package name
  • onboarding issue URL/issue number
  • editor name and GitHub username
  • reviewer1 to reviewerN (reviewer4?) name and GitHub username
  • approved or not (i.e. when the badge is green, no info added to codemeta.json before that)

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
Copy link
Member Author

maelle commented Oct 18, 2018

@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
Copy link
Member

karthik commented Oct 18, 2018

Sure, let me work on that

@maelle
Copy link
Member Author

maelle commented Oct 18, 2018

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

@karthik
Copy link
Member

karthik commented Oct 18, 2018

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

@maelle
Copy link
Member Author

maelle commented Oct 18, 2018

as you prefer

@maelle
Copy link
Member Author

maelle commented Nov 22, 2018

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants