Skip to content

FIX: Update the "intro" section of the peer review guide #146

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

Merged
merged 20 commits into from
Dec 21, 2022

Conversation

lwasser
Copy link
Member

@lwasser lwasser commented Nov 22, 2022

This PR updates and cleans up a lot of content in the About section of the peer review guide. It includes

  • A reorganization of content related to peer review overview
  • It begins to deprecate the code of conduct in favor of it living in our governance docs pyopensci.org/governance/code-of-conduct see issue here for more
  • It adds an explicit benefits of peer review section
  • It adds a technical scope criteria to our reviews in the instance that we have a forked repo where upstream isn't independently sourced.

Copy link
Contributor

@NickleDave NickleDave left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The peer review guide is really coming along and I'm excited to see it get to this point. I see where you are going and I hope my review helps you get there a little easier. 🚀 🐍 ➕ 🧑‍🔬

technical scope listed below.

If you are unsure whether your package is in scope for review, please
open a [pre-submission inquiry using a GitHub Issue](https://github.com/pyOpenSci/software-review/issues/new?assignees=&labels=0%2Fpresubmission&template=presubmission-inquiry.md&title=) to get feedback from
Copy link
Contributor

@Batalex Batalex Dec 9, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The template is well laid out! Would there be a legitimate interest in knowing if the submitting author is committing to the package's maintenance at this point?

Edit: Ok, the 1-2 year(s) of commitment is mentioned elsewhere

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point. @Batalex do you think we should add that to the presubmission template as a link ? we just want to avoid people trying to publish a package (a one time activity) and be done vs vet it and maintain over time.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I took the liberty of submitting a PR: pyOpenSci/software-submission#66

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! i'll look at that PR today as well. going to focus on this pr first and then your pr in software review! thanks @Batalex i do think it's good to set expectations early. otherwise someone would get to the review and maybe walk away then. it saves us all time to tell them early what we expect :) excellent feedback

lwasser and others added 18 commits December 13, 2022 13:14
Co-authored-by: David Nicholson <[email protected]>
Co-authored-by: David Nicholson <[email protected]>
Co-authored-by: David Nicholson <[email protected]>
Co-authored-by: David Nicholson <[email protected]>
Co-authored-by: David Nicholson <[email protected]>
Co-authored-by: David Nicholson <[email protected]>
@lwasser
Copy link
Member Author

lwasser commented Dec 13, 2022

ok @Batalex @arianesasso @NickleDave i've addressed (i think) all of your comments. please feel free to have a look again. i'm going to add a zenodo file to this repo in another PR with your names in it. thank you for all of the great feedback I think it really improved this section of our peer review guidebook

@lwasser
Copy link
Member Author

lwasser commented Dec 21, 2022

oh phew! what a great round of reviews. Thank you everyone!
I am merging this. YES it has a red X.

This is there because
3/4 links are in this PR so they don't exist online. There is a way to fix this with html proofer I just haven't had time to implement it yet. The 4th is the code of conduct which is in governance. there is a PR open for it but I need to have the board review and OK it. So that is coming soon. Maybe i'll work on it a bit more today actually to get that moving as it's important.

for now i'm merging this!! yahoo!

@lwasser
Copy link
Member Author

lwasser commented Dec 21, 2022

The peer review guide is really coming along and I'm excited to see it get to this point. I see where you are going and I hope my review helps you get there a little easier. 🚀 🐍 ➕ 🧑‍🔬

@NickleDave yay!! i'm glad that you see where this is going! and so appreciative of all your feedback and help !! you're definitely helping me and pyOpenSci get to where we want to be!!

@lwasser lwasser merged commit e214523 into pyOpenSci:main Dec 21, 2022
lwasser added a commit to lwasser/software-peer-review that referenced this pull request Dec 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants