Skip to content

Commit 74badc2

Browse files
authored
Merge pull request #357 from pyOpenSci/volume
enh(policy): Add discussion about submission volume
2 parents 39fa69c + f9a17a8 commit 74badc2

File tree

2 files changed

+46
-4
lines changed

2 files changed

+46
-4
lines changed

how-to/author-guide.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ We review packages openly using GitHub Issues.
5151
::::
5252

5353
::::{grid-item}
54-
:::{card} <i class="fa-solid fa-timeline"></i> Review timeline
54+
:::{card} <i class="fa-solid fa-timeline"></i> Review timeline
5555
:link: ../our-process/review-timeline
5656
:link-type: doc
5757
:class-card: left-aligned
@@ -118,6 +118,15 @@ for pyOpenSci.
118118
as we also want to ensure that everyone working on the project receives full credit
119119
for their effort.
120120

121+
```{note}
122+
**Important**: To ensure quality reviews for all submissions and protect our
123+
volunteer review team, each active submission must have a unique point of contact.
124+
If you are currently the point of contact for another package under review, please
125+
wait until that review is complete before submitting another package.
126+
127+
For more details, see our [submission volume policy](submission-volume).
128+
```
129+
121130
```{note}
122131
If your package is more of a tool to support a specific workflow that
123132
either:
@@ -141,8 +150,8 @@ If you have questions about any of the elements listed below, you can
141150
check out our [pyOpenSci Python packaging guide](https://www.pyopensci.org/python-package-guide) which includes an overview discussion of best practices
142151
for Python packaging, including discussions of:
143152

144-
- Tools that you can use to create your package
145-
- Tools for creating and publishing documentation.
153+
- Tools that you can use to create your package,
154+
- Tools for creating and publishing documentation,
146155
- Resources for creating files such as the README file, code of conduct, contributing guide, and more.
147156

148157
```{include} ../appendices/editor-in-chief-checks.md
@@ -259,7 +268,7 @@ default if the package fits into the JOSS scope.
259268

260269
- When you submit your package for pyOpenSci review, you can opt to include a
261270
submission to JOSS after passing pyOpenSci review. In this case, your package
262-
will be evaluated by JOSS through the pyOpenSci review
271+
will be evaluated by JOSS through the pyOpenSci review.
263272
- To complete the JOSS submission, you will also need to craft a **paper.md**
264273
file describing the package following JOSS' standards (see below). More details on the requirements for JOSS can be found on [their website](https://joss.readthedocs.io/en/latest/submitting.html#what-should-my-paper-contain).
265274
- If you choose to opt into the pyOpenSci/JOSS partnership in your review,

our-process/policies.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,39 @@ When submitting a package, please make sure that your GitHub notification
2727
settings are turned on for the software-submission repository to notify you
2828
when you receive feedback on a review issue.
2929

30+
(submission-volume)=
31+
32+
## Submission volume and maintainer overlap
33+
34+
To protect our volunteer peer review team and ensure quality reviews for all
35+
packages, we have policies regarding the volume of simultaneous submissions.
36+
37+
### Unique point of contact requirement
38+
39+
Each submission to pyOpenSci should have one point of contact per package.
40+
Each person listed as a point of contact may have only one submission under
41+
review at a time.
42+
43+
This policy ensures that:
44+
45+
- Review feedback receives appropriate attention from maintainers.
46+
- Maintainers don't become overwhelmed managing multiple concurrent reviews.
47+
- Our volunteer reviewers and editors can focus their efforts effectively.
48+
49+
### Multiple submissions with overlapping maintainer teams
50+
51+
If multiple packages are submitted simultaneously with overlapping maintainer
52+
teams, we will evaluate our volunteer reviewer capacity and may request
53+
staggered submissions to ensure quality review for all packages and to protect
54+
the time and availability of our volunteer editorial team.
55+
56+
We recognize that some situations may warrant exceptions to these guidelines.
57+
For example, two closely related packages that would benefit from review by
58+
the same editorial team may be handled together. All policies may have
59+
exceptions under the discretion of the editors, and decisions will be made by
60+
the Editor-in-Chief based on reviewer capacity and the specific circumstances
61+
of the submission.
62+
3063
## Submitting your package for review in other venues
3164

3265
We recommend submitting your package for review with pyOpenSci before

0 commit comments

Comments
 (0)