Skip to content

Commit b4ff369

Browse files
committed
Fix: move scope to appendix
1 parent 0087966 commit b4ff369

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

scope.md renamed to appendices/scope.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ To be in technical scope for a pyOpenSci review, your package:
2020
* Should be structured in a way that someone else could contribute to it
2121
* Should vendor dependencies using standard approaches rather than including code from other packages within your repository.
2222

23-
2423
### Notes on scope categories
2524
- pyOpenSci is still developing as a community. If your scientific Python
2625
package does not fit into one of the categories or if you have any other
@@ -46,10 +45,8 @@ pyOpenSci has a goal of supporting long term maintenance of open source
4645
Python tools. It is thus important for us to know that if you need to step down as a maintainer, the package infrastructure and documentation is
4746
in place to support us finding a new maintainer who can take over you
4847
package's maintenance.
49-
```
5048
51-
A few examples of technically complex package structures that may
52-
make it difficult for us to review are below:
49+
## Examples of technically complex package structures that may be difficult for us to review
5350
5451
### Example 1: Your package is an out of sync fork of another package repository that is being actively maintained.
5552
@@ -66,9 +63,10 @@ However, if there is a case where a forked repository is warranted, please
6663
consider submitting a pre-submission inquiry first and explain why the package is a
6764
fork rather than an independent parent repository.
6865
69-
### Example 2 Vendored dependencies
66+
### Example 2: Vendored dependencies
7067
7168
If your package is a wrapper that wraps around another tool, we prefer that
7269
the dependency be added as a dependency to your package. This allows
7370
maintenance of the original code base to be independent from your package's
7471
maintenance.
72+
```

software-peer-review-guide/author-guide.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ emphasis on long term software maintenance and focuses more on
5555
publication quality and citation / credit.
5656
```
5757

58-
5958
## 2. Does Your Package Meet Packaging Requirements?
6059
Before submitting your project for review with pyOpenSci, make sure that it
6160
follows the standards and guidelines outlined in the
@@ -84,7 +83,7 @@ up to a week.
8483

8584
Our current categories for determining package scope are below:
8685

87-
```{include} ../scope.md
86+
```{include} ../appendices/scope.md
8887
```
8988

9089
## 4. Submit Your Package for Peer Review
@@ -98,6 +97,12 @@ Once the issue is opened, our editor-in-chief and an editor from our editorial b
9897
to your package to meet minimal criteria before review. They also may reject your
9998
package if it does not fall within our scope.
10099

100+
```{button-link} https://www.pyopensci.org/software-peer-review-guide/editor-in-chief-guide.html#editor-checklist-template
101+
:color: secondary
102+
:class: sd-rounded-pill
103+
Click here to view the editor checks that will be used to evaluate your package.
104+
```
105+
101106
## 6. The Review Begins
102107
If your package meets minimal criteria for being
103108
reviewed it may then be given to an editor with appropriate domain experience

0 commit comments

Comments
 (0)