-
Notifications
You must be signed in to change notification settings - Fork 36
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
sourmash
submission
#129
Comments
Thank you @bluegenes for this detailed submission! I am adding initial checks here:
|
@bluegenes @ctb @luizirber when you have a chance can all three of you please fill out the pre-survey review linked above? In the meantime I will proceed with finding an editor 🙂 |
Sorry for the delay! I am signed on a guest editor and will proceed with finding reviewers. Looking forward to checking out your package. |
I have contacted some reviewers! Hope to have reviewers onboard soon. |
Awesome, thank you for the updates @snacktavish, we really appreciate you acting as editor for this one. Ok I'll let you take over now 🤐 |
Waiting on responses from reviewers - got some No's, but also some recommendations of possible reviewers. Asking more folks and hoping for some yes's! |
Emailing some more potential reviewers today! @bluegenes @ctb @luizirber do you have any reviewer suggestions? |
@snacktavish would it be helpful for us to post about this specific review on social? And then we also have a connection with the single cell community if that might be helpful. Finally, we have a reviewer spreadsheet that might be helpful - people sign up to review for us. if you join us in our pyOpenSci slack we can chat and provide some additional resources that may help in this search for reviewers. you can email me at leah at pyopensci.org ✨ |
Great! We have @LilyAnderssonLee signed on as a reviewer, and she will get started next week. I also have a few more emails out to other folks, hopefully will have a second on-boarded shortly as well! |
Editor comments👋 Hi @LilyAnderssonLee and @elais! Thank you for volunteering to review Please fill out our pre-review surveyBefore beginning your review, please fill out our pre-review survey. This helps us improve all aspects of our review and better understand our community. No personal data will be shared from this survey - it will only be used in an aggregated format by our Executive Director to improve our processes and programs.
The following resources will help you complete your review:
Please get in touch with any questions or concerns! Your review is due: Friday, December 8 |
Hi @LilyAnderssonLee and @elais - we would appreciate getting this review at the end of next week! |
Package ReviewPlease check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide
DocumentationThe package includes all the following forms of documentation:
Readme file requirements
The README should include, from top to bottom:
NOTE: If the README has many more badges, you might want to consider using a table for badges: see this example. Such a table should be more wide than high. (Note that the a badge for pyOpenSci peer-review will be provided upon acceptance.)
UsabilityReviewers are encouraged to submit suggestions (or pull requests) that will improve the usability of the package as a whole.
Functionality
For packages also submitting to JOSS
Note: Be sure to check this carefully, as JOSS's submission requirements and scope differ from pyOpenSci's in terms of what types of packages are accepted. The package contains a
Final approval (post-review)
Estimated hours spent reviewing: Review Comments@bluegenes Outstanding work with
|
thanks for this review! We'll get back to you shortly ;) |
Thanks @LilyAnderssonLee! |
Package ReviewPlease check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide
DocumentationThe package includes all the following forms of documentation:
Readme file requirements
The README should include, from top to bottom:
NOTE: If the README has many more badges, you might want to consider using a table for badges: see this example. Such a table should be more wide than high. (Note that the a badge for pyOpenSci peer-review will be provided upon acceptance.)
UsabilityReviewers are encouraged to submit suggestions (or pull requests) that will improve the usability of the package as a whole.
Functionality
For packages also submitting to JOSS
Note: Be sure to check this carefully, as JOSS's submission requirements and scope differ from pyOpenSci's in terms of what types of packages are accepted. The package contains a
Final approval (post-review)
Estimated hours spent reviewing: Review Comments@bluegenes This is one of the best maintained packages I've seen. The development environment is easy to setup and work in, each commit has meaningful messages attached, and the documentation is extensive and up to date. I plan on showing this repository to my own team concerning how projects should look when maintained well. I ran into a few hiccups along the way however
|
Thank you reviewers! I’ll look over these when I’m back at work next week. |
OK! I looked over the reviews, which were both very positive. Congratulations @bluegenes on your very nice package! Post here when the reviews have been addressed and the reviewers will look over the changes. Thanks @elais and @LilyAnderssonLee for your thoughtful reviews! |
yay!! I heard back, and you are officially good to go! Congratulations and I apologize for the slow review process. |
🎉Sourmash has been approved by pyOpenSci! Thank you @bluegenes @luizirber and @ctb for submitting sourmash and many thanks to @elais and @LilyAnderssonLee for reviewing this package! 😸 Author Wrap Up TasksThere are a few things left to do to wrap up this submission:
It looks like you would like to submit this package to JOSS. Here are the next steps:
Editor Final ChecksPlease complete the final steps to wrap up this review. Editor, please do the following:
If you have any feedback for us about the review process please feel free to share it here. We are always looking to improve our process and documentation in the peer-review-guide. |
thanks all! really happy! 🎉 question: if we want to go for JOSS, should we do a new release now, for pyopensci, and then another, assuming JOSS accepts? or can we wait and just do a release if/when JOSS accepts? we don't have a real reason for a new release just yet (we've been doing them regularly anyway!) so could go either way. Just curious. (we have citation instructions in the software that we would change for the JOSS release.) |
Add pyopensci review badge, linking to accepted review: pyOpenSci/software-submission#129
I checked in with @lwasser and we say - Thank you! |
Thanks @snacktavish @lwasser!! for tracking: Author Wrap Up TasksThere are a few things left to do to wrap up this submission:
It looks like you would like to submit this package to JOSS. Here are the next steps:
|
hey there everyone! i'm just checking in on editor wrap up tasks here!! a few things @bluegenes @LilyAnderssonLee @elais - if you have time, can you kindly complete our post-review survey? we really appreciate your input as it helps us improve our review process and it also helps us when we write writeups for funders, etc demonstrate impact. It looks like titus did complete it
|
I misread this the first time to be "did you make substantial changes b/t pyopensci and JOSS reviews", and was like, nope! And then I reread it and was like, oh, yes, in the ~5 years and 3 major versions of sourmash, we have indeed made substantial updates to the package 😆 |
a statement rarely found in the wild |
Ok a few more items We'd LOVE for you and your team to write a blog post on SourMash for us to promote your work! if you are interested - here are a few examples of other blog posts: you can direct any questions to @kierisi on the blog post if that is of interest! here is a markdown example that you could use as a guide when creating your post. it can even be a tutorial like post that highlights what your package does. Then we can share it with people to get the word out about your package. If you are too busy for this no worries. But if you have time - we'd love to spread the word about your package! Finally - EVERYONE involved in this review (authors, editors, reviewers, etc) is invited to join our pyOpenSci slack. If you are interested, please reply and @kierisi can ensure that you get an invite! Thank you everyone. You may here from me again as i just cross additional I really appreciate ALL of the effort htat went into this review from EVERYONE here in this issue. Thank you all for being a part of the wonderful pyOpenSci community. You all make it the supportive community that it is 💟 |
@ctb 🤣 🤣 but we have it now IN WRITING! (and under version control at that!) |
I filled it out - do you not have mine? I can redo if you need |
we'd love to -- I'll reach out again when we have something.
yes - I'd be happy to join the slack! |
i believe you - i wonder what happened. i see titus but not anyone else from this review. i just tested out the form and it seems to work... if you have the bandwidth to take 5-10 minutes to fill it out i'd greatly appreciate it! thank you so much. maybe something odd happened in the google-form-verse? |
@bluegenes sending the invite now! |
thank you @kierisi !! 🚀 also @bluegenes if you have any questions about the blog side of things - jesse can help!! |
Closing this as it was accepted by joss in June!! thank you everyone! |
Yay!!! Congrats to all!! |
hey there @snacktavish 👋🏻 just saying hello!! 💖 thank you for the work that you did on this review!! |
Submitting Author: Tessa Pierce-Ward (@bluegenes)
All current maintainers: @ctb, @luizirber, @bluegenes
Package Name: sourmash
One-Line Description of Package:
sourmash
is a command line tool and Python library for sketching collections of DNA, RNA, and amino acid k-mers for biological sequence search, comparison, and analysis.Repository Link: https://github.com/sourmash-bio/sourmash
Version submitted: 4.8
Editor: @snacktavish Emily Jane McTavish
EiC: @NickleDave
Reviewer 1: @LilyAnderssonLee Lili Andersson-Li
Reviewer 2: @elais Elais Player
Archive:
Version accepted: v4.8.8
JOSS:
Date accepted (month/day/year): 4/4/2024
Code of Conduct & Commitment to Maintain Package
Description
Scope
Please indicate which category or categories.
Check out our package scope page to learn more about our
scope. (If you are unsure of which category you fit, we suggest you make a pre-submission inquiry):
Domain Specific & Community Partnerships
Community Partnerships
If your package is associated with an
existing community please check below:
For all submissions, explain how the and why the package falls under the categories you indicated above. In your explanation, please address the following points (briefly, 1-2 sentences for each):
@tag
the editor you contacted:Technical checks
For details about the pyOpenSci packaging requirements, see our packaging guide. Confirm each of the following by checking the box. This package:
Publication Options
JOSS Checks
paper.md
matching JOSS's requirements with a high-level description in the package root or ininst/
.Note: JOSS accepts our review as theirs. You will NOT need to go through another full review. JOSS will only review your paper.md file. Be sure to link to this pyOpenSci issue when a JOSS issue is opened for your package. Also be sure to tell the JOSS editor that this is a pyOpenSci reviewed package once you reach this step.
Are you OK with Reviewers Submitting Issues and/or pull requests to your Repo Directly?
This option will allow reviewers to open smaller issues that can then be linked to PR's rather than submitting a more dense text based review. It will also allow you to demonstrate addressing the issue via PR links.
Confirm each of the following by checking the box.
Please fill out our survey
submission and improve our peer review process. We will also ask our reviewers
and editors to fill this out.
P.S. Have feedback/comments about our review process? Leave a comment here
Editor and Review Templates
The editor template can be found here.
The review template can be found here.
Footnotes
Please fill out a pre-submission inquiry before submitting a data visualization package. ↩
The text was updated successfully, but these errors were encountered: