Skip to content

feat: add implementation pages in the guidebook to support peer review #526

Open
@lwasser

Description

@lwasser

In our slack, @coatless made some great suggestions as our current Editor in Chief regarding gaps in our guidebook related to our peer review process and how things could be more seamless as we work through peer review.

These guides are conceptually strong; but, leave some of the implementation examples MIA:
https://www.pyopensci.org/python-package-guide/documentation/index.html
https://www.pyopensci.org/python-package-guide/tests/index.html

I think that it would be better for the EiC to have more concrete examples in the guide so we can link to the guide (and we can also link out from the guide if there are better things to just point to in some cases).

But in the spirit of "one way to do things" having working examples (that are in our copier template) would be invaluable.

@coatless are examples of how to setup docs and how to setup tests the place where we should start? this would also be documentation for our copier template

or do you have anything to add / did I miss things that you think are missing here?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions