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

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

Open
maelle opened this issue Sep 7, 2018 · 30 comments
Open
Assignees
Labels

Comments

@maelle
Copy link
Member

maelle commented Sep 7, 2018

Idea by @noamross

Thoughts, badge master @karthik?

@maelle maelle added the image label Sep 7, 2018
@karthik
Copy link
Member

karthik commented Sep 7, 2018

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

@maelle
Copy link
Member Author

maelle commented Sep 7, 2018

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

@maelle
Copy link
Member Author

maelle commented Nov 6, 2018

@karthik could you add this to the svg? 😺

@karthik
Copy link
Member

karthik commented Nov 6, 2018

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

karthik commented Nov 6, 2018

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

image

@maelle
Copy link
Member Author

maelle commented Nov 7, 2018

LGTM

@noamross ?

@karthik
Copy link
Member

karthik commented Nov 7, 2018

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

maelle commented Nov 7, 2018

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

cboettig commented Nov 7, 2018

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

@karthik
Copy link
Member

karthik commented Nov 8, 2018

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

maelle commented Nov 8, 2018

Nice!

@karthik
Copy link
Member

karthik commented Nov 8, 2018

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

karthik commented Nov 8, 2018

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

karthik commented Nov 8, 2018

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

karthik commented Nov 8, 2018

See a live badge here

@jeroen
Copy link
Member

jeroen commented Nov 8, 2018

I think you just need to decrease the textLength property?

@karthik
Copy link
Member

karthik commented Nov 8, 2018

Nice! I fixed it.

@jeroen
Copy link
Member

jeroen commented Nov 8, 2018

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

@karthik
Copy link
Member

karthik commented Nov 8, 2018

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

@noamross
Copy link
Contributor

noamross commented Nov 8, 2018

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

@karthik
Copy link
Member

karthik commented Nov 8, 2018

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

@karthik
Copy link
Member

karthik commented Nov 8, 2018

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

karthik commented Nov 8, 2018

I suppose editors could also do this manually for now.

@noamross
Copy link
Contributor

noamross commented Nov 8, 2018

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

noamross commented Dec 4, 2018

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

karthik commented Dec 5, 2018

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

karthik commented Dec 5, 2018

I created a draft here: https://airtable.com/tblW571HaPslf14L7/viwX095g0RmqWGsSk

@karthik
Copy link
Member

karthik commented Dec 5, 2018

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

maelle commented Jan 22, 2019

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

@maelle
Copy link
Member Author

maelle commented Jun 21, 2022

ropensci-org/buffy#76

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

No branches or pull requests

5 participants