-
-
Notifications
You must be signed in to change notification settings - Fork 38
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]: Jury: A Comprehensive Evaluation Toolkit #6452
Comments
Hello humans, I'm @editorialbot, a robot that can help you with some common editorial tasks. For a list of things I can do to help you, just type:
For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:
|
Software report:
Commit count by author:
|
|
Paper file info: 📄 Wordcount for ✅ The paper includes a |
License info: ✅ License found: |
👋 @devrimcavusoglu , @evamaxfield , and @KennethEnevoldsen - This is the review thread for the paper. All of our communications will happen here from now on. Please read the "Reviewer instructions & questions" in the first comment above. Both reviewers have checklists at the top of this thread (in that first comment) with the JOSS requirements. As you go over the submission, please check any items that you feel have been satisfied. There are also links to the JOSS reviewer guidelines. The JOSS review is different from most other journals. Our goal is to work with the authors to help them meet our criteria instead of merely passing judgment on the submission. As such, the reviewers are encouraged to submit issues and pull requests on the software repository. When doing so, please mention #6452 so that a link is created to this thread (and I can keep an eye on what is happening). Please also feel free to comment and ask questions on this thread. In my experience, it is better to post comments/questions/suggestions as you come across them instead of waiting until you've reviewed the entire package. We aim for the review process to be completed within about 4-6 weeks but please make a start well ahead of this as JOSS reviews are by their nature iterative and any early feedback you may be able to provide to the author will be very helpful in meeting this schedule. |
Review checklist for @evamaxfieldConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
@crvernon I will start checking these off tomorrow and likely finish next week unless I run into any major issues. |
Review checklist for @KennethEnevoldsenConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
@devrimcavusoglu this looks like a wonderful work, which I am sure will be beneficial to many people (seems like it already is). Overall I was able to run both the examples, tests and installation without issues and found that almost all of the information (required and desired) was available. I have a few things I was hoping you could clear up:
|
@devrimcavusoglu seconding that this is really great and I will likely start using it in some of my own work :) Some comments:
|
@evamaxfield to your question:
We don't require documentation to be hosted separately; though it is a nice complement that many reviewers have started to point out. I would say this falls under the category of suggestion but not requirement as long as the codebase has the necessary documentation that is visible to the user. Thanks! |
Sounds good! Then my comment resolves to simply adding a link to the examples notebook. |
@KennethEnevoldsen @evamaxfield Thank you for the reviews and feedback. Apologizes for a late response. I will try to respond to items that you mentioned. Response to @KennethEnevoldsen:
We did not actually documented this as we think for most of the open-source software the Github platform is the de facto standard for raising issues, bug reports, discussions and etc. If we were using another platform for those stuff we could've mentioned it which is reasonable; however, utilizing the standard does not necessitate this as it is the standard and easy to be grasped by all users. Nonetheless, we particularly included templates for the issues (e.g. bug reports, feature/metric request).
Yes, there is a comparison in the paper, particularly Fig. 2. Jury is compared to HF metrics package in two different perspectives, input size and number of metrics. Response to @evamaxfield:
Actually, we do have link to the notebook as a Google Colab link although it's not expressed and written down, for example, in a table in README. This way we think is more user friendly as the users can directly engage with the package and play around.
That is a really good suggestion, we may definitely plan to add this feature in upcoming versions. |
I am perfectly fine with this as long as the editors (@crvernon) agree. I will leave it unchecked on the checklist.
Thanks for the clarification I believe this clarifies all my points. |
I definitely missed the open in collab button. I will check that off and the contributing section. All good from my review :) |
Per @KennethEnevoldsen 's comment...
I do believe there needs to be a bit more here to meet the guidelines for:
Even though I do agree that many users may be aware of what issues and pull requests are, our papers go out to a general audience. Thus, questions and contributions may not always come in the form of code modifications/additions from engineers, but from program managers, etc. who seek clarity on the purpose of the software in the context of their mission. These audiences often do not have familiarity with how GitHub works. So I do advise @devrimcavusoglu to be more descriptive for how to contribute. Feel free to check out previous JOSS publications for some examples. Thanks! |
@crvernon I see the point, thanks for clarfying. I will make appropriate updates in the repo ASAP and will ping you then. |
👋 @devrimcavusoglu, @evamaxfield, and @KennethEnevoldsen I'm just checking in to see how things are going. I believe @evamaxfield has finished their review and there were a few things left to do pertaining to the review from @KennethEnevoldsen. Will you please provide a short update to how things are going? Thanks! |
With the addition of community guidelines I don't believe there is any additions I want to add. I believe it is a good paper/package which provides solid tools for developers. |
Great, thanks @KennethEnevoldsen! @devrimcavusoglu let me know when you have the community guidelines element addressed and are ready for me to take my final look. |
@crvernon I updated the repo for regarding changes. You can access to the community guidline in the repo. Thank you for review and fruitful discussion. @KennethEnevoldsen @evamaxfield @crvernon |
@editorialbot generate pdf |
Done! version is now v2.3.1 |
@devrimcavusoglu no need to do another release, but please edit the authors in the Zenodo record metadata to match the authors and order of those who appear in your paper. Also...please ensure that the title of the Zenodo record matches exactly with what is in the paper. Please let me know when this is done so we can move forward. |
@crvernon I updated the zenodo version, as you suggested under the same version, I updated the metadata. |
@devrimcavusoglu the titles still do not match.
Please fix both issue to match what is in the paper. |
@crvernon sorry for the inconvenience, I updated the zenodo version with the proper name and corrected author order. |
@editorialbot check references |
|
@editorialbot set 10.5281/zenodo.11170894 as archive |
Done! archive is now 10.5281/zenodo.11170894 |
@editorialbot recommend-accept |
|
|
👋 @openjournals/dsais-eics, this paper is ready to be accepted and published. Check final proof 👉📄 Download article If the paper PDF and the deposit XML files look good in openjournals/joss-papers#5360, then you can now move forward with accepting the submission by compiling again with the command |
Alright @devrimcavusoglu, take a final look at the proof above and make sure all is well from your side and let me know when you are satisfied with it. Then I'll accept this one for publication in full. |
@crvernon I just checked the proof, LGTM 👍 I didn't want to provide a link to the arxiv, but I don't know we can do such thing. If joss allow, I can cite/provide our arxiv paper as well. If not, we can proceed with this latest proof. |
@devrimcavusoglu - We have no problems with the preprint. See https://joss.readthedocs.io/en/latest/submitting.html#preprint-policy Just let me know if you alter the paper and I'll recheck. If not, just let me know and we can move forward. Thanks! |
@crvernon I rechecked it and I think there's no need for any revision. We can proceed with this version. |
@editorialbot accept |
|
Ensure proper citation by uploading a plain text CITATION.cff file to the default branch of your repository. If using GitHub, a Cite this repository menu will appear in the About section, containing both APA and BibTeX formats. When exported to Zotero using a browser plugin, Zotero will automatically create an entry using the information contained in the .cff file. You can copy the contents for your CITATION.cff file here: CITATION.cff
If the repository is not hosted on GitHub, a .cff file can still be uploaded to set your preferred citation. Users will be able to manually copy and paste the citation. |
🐘🐘🐘 👉 Toot for this paper 👈 🐘🐘🐘 |
🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨 Here's what you must now do:
Any issues? Notify your editorial technical team... |
🥳 Congratulations on your new publication @devrimcavusoglu! Many thanks to @evamaxfield and @KennethEnevoldsen for your time, hard work, and expertise in reviewing!! JOSS wouldn't be able to function nor succeed without your efforts. Please consider becoming a reviewer for JOSS if you are not already: https://reviewers.joss.theoj.org/join |
🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉 If you would like to include a link to your paper from your README use the following code snippets:
This is how it will look in your documentation: We need your help! The Journal of Open Source Software is a community-run journal and relies upon volunteer effort. If you'd like to support us please consider doing either one (or both) of the the following:
|
Submitting author: @devrimcavusoglu (Devrim Çavuşoğlu)
Repository: https://github.com/obss/jury
Branch with paper.md (empty if default branch): joss-paper
Version: v2.3.1
Editor: @crvernon
Reviewers: @evamaxfield, @KennethEnevoldsen
Archive: 10.5281/zenodo.11170894
Status
Status badge code:
Reviewers and authors:
Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) by leaving comments in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)
Reviewer instructions & questions
@evamaxfield & @KennethEnevoldsen, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review.
First of all you need to run this command in a separate comment to create the checklist:
The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @crvernon know.
✨ Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest ✨
Checklists
📝 Checklist for @evamaxfield
📝 Checklist for @KennethEnevoldsen
The text was updated successfully, but these errors were encountered: