ropensci / software-review-meta

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

Add which version of the package was reviewed to the peer-review badge #61

Open maelle opened 6 years ago

maelle commented 6 years ago

Idea by @noamross

Thoughts, badge master @karthik?

karthik commented 6 years ago

We can certainly add that. If editors are on board, I will update the badge generator to do this.

maelle commented 6 years ago

I am on board. We should add to the approval template to bump the version number before transferring.

maelle commented 5 years ago

@karthik could you add this to the svg? 😺

karthik commented 5 years ago

Let me work on that. Right now I just have 3 base svgs (unknown, in review, and peer-reviewed). I don't edit the svgs, but will have to figure out how do that programmatically. Stay tuned :)

karthik commented 5 years ago

Something like this? I tested this with the longest version we have had so far (from Carl of course!)

image

maelle commented 5 years ago

LGTM

@noamross ?

karthik commented 5 years ago

Note that in original size, this new badge is actually unreadable. This is way too much text for a tiny badge and I don't have a good solution to this but I'll keep looking.

maelle commented 5 years ago

Maybe we should put a condition on versions, i.e. upping the version before acceptance to something with 3 numbers and 2 periods max?

cboettig commented 5 years ago

ha, serves me right for leaving a version number at the usethis default!

karthik commented 5 years ago

Here is a different version that is longer but also readable. I will add the ropensci logo once the version is finalized. Thoughts on this one?

image

maelle commented 5 years ago

Nice!

karthik commented 5 years ago

How is this for an attempt?

For a pending one (without and with)

For an accepted one (without and with)

Known issues: The svg tried to fill the space with the text so that's why the text spacing is so wide when the version number isn't too long. When it is long, it looks fine. e.g.

Not sure how to fix this. If I make the badge with narrower, longer versions will overflow the text.

karthik commented 5 years ago

Note that I deployed these new badges already (without yet replacing our current ones). To see the new ones, replace <issue_number>_status.svg with <issue_number>v.svg

karthik commented 5 years ago

@jeroen Do you have some good svg foo to fix the text spacing issues? I tried playing with the text-spacing style, kerning, etc and nothing really worked.

karthik commented 5 years ago

See a live badge here

jeroen commented 5 years ago

I think you just need to decrease the textLength property?

karthik commented 5 years ago

Nice! I fixed it.

jeroen commented 5 years ago

Maybe also decrease the <svg width="192" and <text x="1085" so that it's a bit smaller?

karthik commented 5 years ago

I'll leave those two be otherwise the longest version number badge text will not fit.

noamross commented 5 years ago

How do we determine/record what the version at acceptance is?

karthik commented 5 years ago

Good question. Right now this just scrapes what they put into their submission.

karthik commented 5 years ago

Would be nice to have a whedon style bot that records this in the first comment when closing the thread.

version submitted: foo
version accepted: foo.0.1.1.9999
karthik commented 5 years ago

I suppose editors could also do this manually for now.

noamross commented 5 years ago

For the bot list! So this should be in the editor's checklist/template, and we'll want to write a script that goes back and records this retrospectively for previous acceptances.

noamross commented 5 years ago

What's the current status of these badges? Can they be deployed manually? Do we do so by putting in the text above, or can we specify the version in the badge URL?

karthik commented 5 years ago

Nothing has changed as far as status. If we are to do this manually, we should consider (as per slack discussion) starting a new airtable with accepted package metadata. Copying over from slack:

Package name
Author(s)
affiliation(s)
submission URL
reviewers
date submitted
date accepted
editor
version accepted
JOSS
MEE

and then auto generate badges from there.

karthik commented 5 years ago
karthik commented 5 years ago

We need to manually fill in: version accepted (at the least) and then the rest of the info. Then we can automate going forward.

maelle commented 5 years ago

What is the status on this @karthik i.e. what needs to be done?