Skip to content

feat: Add cross links between author checks in our peer review guide and guidance in the packaging guide #42

Open
@lwasser

Description

@lwasser
    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)

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    Status

    Beginner Friendly / Non Technical

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions