Skip to content

Cross linking between author checks in our peer review guide and guidance in the packaging guide #42

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

Open
lwasser opened this issue Jan 10, 2023 · 1 comment

Comments

@lwasser
Copy link
Member

lwasser commented Jan 10, 2023

    ok yes this is confusing isn't it. we should actually link over to the author checks rather than have a requirements list embedded here

this is what we have now - https://www.pyopensci.org/peer-review-guide/software-peer-review-guide/author-guide.html#does-your-package-meet-packaging-requirements but i see how it's going to confuse readers.

And THIS represents the initial checks:

https://www.pyopensci.org/peer-review-guide/software-peer-review-guide/editor-in-chief-guide.html#editor-checklist-template

I also just found a BROKEN LINK in the authors guide to the EIC checklist. i wonder how we missed that!

@NickleDave pinging you and @arianesasso on this one. we need to better coordinate between the two guides to ensure authors know what the checks are. i think specific checklists belong in the author guide as include files. then we can LINK to more information here to help them implement those checks. but it will require some thought about cross referencing. I also noticed a link is broken to EIC checks in the author guide!

Originally posted by @lwasser in #19 (comment)

@arianesasso
Copy link
Contributor

Just copying my comment from there here 🙈 :

I checked the links, and the link to the EIC checklist is probably not needed at that point. Then, the checklist listed above could be a link to the EIC page (where it makes sense for the checklist to live), as you mentioned @lwasser. I also missed a link in the author's guide to this page, e. g. here: Resources for creating files such as the README [Link here to readme-file-best-practices] file, code of conduct, contributing guide, and more.

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

No branches or pull requests

2 participants