You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: about-peer-review/code-of-conduct.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ go there now.](https://www.pyopensci.org/governance/code-of-conduct)
7
7
## NOTE: we are in the process of moving this file to our governance documentation and making significant changes to our code of conduct.
8
8
9
9
10
-
- We are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, disability, ethnicity, religion, or similar personal characteristic.
10
+
- We are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, disability, ethnicity, religion, age, or any personal characteristics.
11
11
- Please avoid using openly sexual nicknames or other nicknames that might detract from a friendly, safe and welcoming environment for all.
12
12
- Please be kind and courteous. There’s no need to be mean or rude.
13
13
- Respect that people have differences of opinion and that every design or implementation choice carries a trade-off and numerous costs. There is seldom a right answer.
Copy file name to clipboardExpand all lines: about-peer-review/how-peer-review-works.md
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ high quality tools
10
10
that supports scientists across domains with a suite of different data
11
11
types and structures.
12
12
13
-
### Who reviews pyOpenSci packages?
13
+
### Who reviews pyOpenSci packages?
14
14
15
15
Our peer review process is run by volunteer members of the Python scientific
16
16
community:
@@ -30,22 +30,22 @@ Our entire peer review process occurs on GitHub in the
30
30
31
31
We use GitHub because:
32
32
33
-
* It is free to create an account
34
-
* Anyone can read the review discussion without an account making the process entirely open
35
-
* It facilitates collaboration and supports community around a package
36
-
* It facilitates open discussion between reviewers and package maintainers and the pyOpenSci volunteers
37
-
* Numerous packages store their code bases on GitHub
33
+
* It is free to create an account,
34
+
* Anyone can read the review discussion without an account, making the process entirely open,
35
+
* It facilitates collaboration and supports the community around a package,
36
+
* It facilitates an open discussion between reviewers, package maintainers and the pyOpenSci volunteers,
37
+
* Numerous packages store their code bases on GitHub.
38
38
39
39
### We use GitHub issue templates and labels to organize the review steps
40
40
41
41
* We use GitHub issue templates as submission templates for new reviews and pre-submission review questions.
42
-
* We label issues to track every step of the package submission and review progress (e.g. [1/initial-editor-checks, 2/reviewers-needed, 6/pyopensci-approved](https://github.com/pyOpenSci/software-review/labels)
42
+
* We label issues to track every step of the package submission and review progress (e.g. [1/initial-editor-checks, 2/reviewers-needed, 6/pyopensci-approved](https://github.com/pyOpenSci/software-review/labels)).
43
43
44
44
```{note}
45
45
[Click here to read the review thread from a December 2022
46
46
pyOpenSci pre-submission issue.](https://github.com/pyOpenSci/software-review/issues/65) Note the conversational
47
47
tone of the pre-review. In this case the package was improved
48
-
Before the formal review even began.
48
+
before the formal review even began.
49
49
50
50
In the actual review process, two external reviews are important milestones. The editor will also provide the author with some feedback.
Copy file name to clipboardExpand all lines: about-peer-review/intro.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Software peer review refers to a peer-review process that focuses on open source
10
10
* Code quality,
11
11
* Documentation quality,
12
12
* Package usability,
13
-
* Test coverage that supports both maintenance of code function. Test coverage also makes it easier for contributors to see how their contributions impacts other parts of the code,
13
+
* Test coverage that supports the maintenance of code function. Test coverage also makes it easier for contributors to see how their contributions impact other parts of the code,
14
14
* Evaluation of infrastructure such as continuous integration to run rest suites and check code linters, that supports automated checks on pull requests. This infrastructure supports software quality and reliability.
15
15
16
16
## What types of packages does pyOpenSci review?
@@ -20,7 +20,7 @@ pyOpenSci reviews higher level software packages that support scientific workflo
20
20
21
21
<imgsrc="../images/python-stack-jupyter-earth.png"alt="Image showing the tiers of software in the python ecosystem starting with Python itself and as you move out packages become more domain specific. In this image packages like xarray and numpy are considered core to scientific python. Packages and distributions like astropy, simpeg and metpy are considered to be domain specific."width="700px">
22
22
23
-
Diagram showing the tiers of software in the python ecosystem starting with Python itself and as you move out packages become more domain specific. In this image packages like xarray and numpy are considered core to scientific python. Packages and distributions like astropy, simpeg and metpy are considered to be domain specific.. pyOpenSci's review
23
+
Diagram showing the tiers of software in the python ecosystem starting with Python itself and as you move out packages become more domain specific. In this image packages like xarray and numpy are considered core to scientific python. Packages and distributions like astropy, simpeg and metpy are considered to be domain specific. pyOpenSci's review
24
24
process focuses on domain specific packages rather than core packages as
25
25
these packages tend to have more variability in long term maintenance and
26
26
package infrastructure and quality compared to established core packages. **Source: ["Jupyter meets earth" project](https://jupytearth.org/jupyter-resources/introduction/ecosystem.html)**
@@ -54,7 +54,7 @@ faced within the scientific Python community are broader in scale given the
54
54
numerous and diverse applications that the Python programming language is used for.
55
55
56
56
```{note}
57
-
[This blog post](https://www.numfocus.org/blog/how-ropensci-uses-code-review-to-promote-reproducible-science/) written by editors from our partner organization, rOpenSci, is a good introduction to pyOpenSci software peer review
57
+
[This blog post](https://www.numfocus.org/blog/how-ropensci-uses-code-review-to-promote-reproducible-science/) written by editors from our partner organization, rOpenSci, is a good introduction to pyOpenSci software peer review.
58
58
```
59
59
60
60
### Peer review of open source software helps maintain consistent quality
Copy file name to clipboardExpand all lines: about-peer-review/policies-guidelines.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -7,11 +7,11 @@ documentation and usability. The review process
7
7
is similar to a manuscript review, however it has a stronger
8
8
focus on Python packaging best practices.
9
9
10
-
Unlike a manuscript review, our peer review process is be an ongoing conversation. Once all major issues and questions are addressed, the review editor package will make a decision to accept, hold, or reject the package.
10
+
Unlike a manuscript review, our peer review process is an ongoing conversation. Once all major issues and questions are addressed, the review editor package will make a decision to accept, hold, or reject the package.
11
11
12
12
Rejections are usually done early in the process, before the review process begins. In rare cases a package may also not be on-boarded into the pyOpenSci ecosystem after review & revision.
13
13
14
-
It is ultimately editor’s decision on whether or not to reject the package based on how the reviews are addressed.
14
+
It is ultimately the editor’s decision on whether or not to reject the package based on how the reviews are addressed.
Copy file name to clipboardExpand all lines: about-peer-review/pyopensci-related-joss-ropensci.md
+10-10Lines changed: 10 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -11,26 +11,26 @@ The JOSS review process is about publication. A review from JOSS will provide
11
11
you with a citable, [Crossref digital object identifier (DOI)](https://www.crossref.org/).
12
12
pyOpenSci aligns closely with the broad mission of
13
13
JOSS to provide maintainers with credit for their open source work. However,
14
-
our mission is also more focused. pyOpenSci not open source maintainers getting academic credit for their work. We also support:
14
+
our mission is also more focused. pyOpenSci is not just about open source maintainers getting academic credit for their work. We also support:
15
15
16
-
* the Python tools that drive scientific open reproducible science workflows;
17
-
*enforcement and encouragement of Python-specific packaging standards across tools;
18
-
*and curated lists of peer reviewed, and maintained Python scientific software.
16
+
* the Python tools that drive scientific open reproducible science workflows;
17
+
*Enforcement and encouragement of Python-specific packaging standards across tools;
18
+
*Curated lists of peer reviewed, and maintained Python scientific software.
19
19
20
20
## How is review at pyOpenSci different from the JOSS review process?
21
21
22
22
We are not a typical publisher or journal. Rather we are a community that provides support for both a diverse group of software maintainers and long term maintenance of our packages.
23
23
24
24
The pyOpenSci review process is different from that of JOSS in a few ways:
25
25
26
-
1. Our review is specifically design to enforce modern, community-accepted best practices for Python packaging.
26
+
1. Our review is specifically designed to enforce modern, community-accepted best practices for Python packaging.
27
27
1. We place heavy emphasis on documentation and usability in our reviews and associated standardization of both.
28
28
1. We build community around and visibility for its tools.
29
29
1. We will promote packages and package maintainers once they are accepted into our ecosystem.
30
-
1. We support long term maintenance of packages. If the maintainer needs to step down, we will ensure a new maintainer takes over OR sunset and remove the package from our ecosystem.
30
+
1. We support long term maintenance of packages. If the maintainer needs to step down, we will ensure a new maintainer takes over or sunset and remove the package from our ecosystem.
31
31
1. We provide a welcoming forum for you to ask questions and get help with maintaining your package as needed.
32
32
33
-
JOSS reviews are also [more limited in scope](https://joss.readthedocs.io/en/latest/review_criteria.html)
33
+
JOSS reviews are also [more limited in scope](https://joss.readthedocs.io/en/latest/submitting.html?highlight=scope#submission-requirements)
Copy file name to clipboardExpand all lines: appendices/editor-in-chief-checks.md
+13-13Lines changed: 13 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -6,20 +6,20 @@ review. Below are the basic checks that your package needs to pass
6
6
to begin our review. If some of these are missing, we will ask you
7
7
to work on them before the review process begins.
8
8
9
-
- [ ] **Installation** The package can be installed from a community repository such as PyPI (preferred), and/or a community channel on conda (e.g. conda-forge, bioconda)
10
-
- [ ] The package imports properly into a standard Python environment `import package-name`
11
-
- [ ] **Fit**: The package meets criteria for [fit](https://www.pyopensci.org/peer-review-guide/about-peer-review/aims-and-scope.html#package-scope) and [overlap](https://www.pyopensci.org/peer-review-guide/about-peer-review/aims-and-scope.html#package-overlap).
12
-
- [ ] **Documentation** The package has sufficient documentation available online (README, sphinx docs) to allow us to evaluate package function and scope *without installing the package*. This includes:
9
+
- [ ] **Installation** The package can be installed from a community repository such as PyPI (preferred), and/or a community channel on conda (e.g. conda-forge, bioconda).
10
+
- [ ] The package imports properly into a standard Python environment `import package-name`.
11
+
- [ ] **Fit** The package meets criteria for [fit](https://www.pyopensci.org/peer-review-guide/about-peer-review/aims-and-scope.html#package-scope) and [overlap](https://www.pyopensci.org/peer-review-guide/about-peer-review/aims-and-scope.html#package-overlap).
12
+
- [ ] **Documentation** The package has sufficient online documentation (README, sphinx docs) to allow us to evaluate package function and scope *without installing the package*. This includes:
13
13
- [ ] Short tutorials or [vignettes](https://kbroman.org/pkg_primer/pages/vignettes.html) that help a user understand how to use the package and what it can do for them (often these have a name like "Getting started")
14
-
- [ ] API documentation: this includes clearly written docstrings with variables defined using a standard docstring format. *We suggest using the [Numpy](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard) docstring format.*
15
-
- [ ] **README:** The package has a `README.md` file with clear explanation of what the package does, instructions on how to install it, and a link to development instructions.
16
-
- [ ] **Contributing File:** The package has a `CONTRIBUTING.md` file that details how to install and contribute to the package.
17
-
- [ ] **Issue Submission Documentation**: All of the information is filled out in the `YAML` header of the issue (located at the top of the issue template).
18
-
- [ ] **Automated tests:** Package has a testing suite and is tested via GitHub actions or another Continuous Integration service.
19
-
- [ ] **License:** The package has an [OSI approved license](https://opensource.org/licenses)
20
-
- [ ] **Repository:** The repository link resolves correctly
21
-
- [ ] **Package overlap:** That package doesn't fully overlap with functionality of other packages that have already been submitted to pyOpenSci
22
-
- [ ] **Archive** (JOSS only, may be post-review): The repository DOI resolves correctly
14
+
- [ ] API documentation: this includes clearly written docstrings with variables defined using a standard docstring format. *We suggest using the [Numpy](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard) docstring format*.
15
+
- [ ] **README** The package has a `README.md` file with clear explanation of what the package does, instructions on how to install it, and a link to development instructions.
16
+
- [ ] **Contributing File** The package has a `CONTRIBUTING.md` file that details how to install and contribute to the package.
17
+
- [ ] **Issue Submission Documentation** All of the information is filled out in the `YAML` header of the issue (located at the top of the issue template).
18
+
- [ ] **Automated tests** Package has a testing suite and is tested via GitHub actions or another Continuous Integration service.
19
+
- [ ] **License** The package has an [OSI approved license](https://opensource.org/licenses).
20
+
- [ ] **Repository** The repository link resolves correctly.
21
+
- [ ] **Package overlap** The package doesn't entirely overlap with the functionality of other packages that have already been submitted to pyOpenSci.
22
+
- [ ] **Archive** (JOSS only, may be post-review): The repository DOI resolves correctly.
23
23
- [ ] **Version** (JOSS only, may be post-review): Does the release version given match the GitHub release (v1.0.0)?
Copy file name to clipboardExpand all lines: appendices/package-approval-template.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -5,15 +5,15 @@
5
5
There are a few things left to do to wrap up this submission:
6
6
- [ ] Activate [Zenodo](https://zenodo.org/) watching the repo if you haven't already done so.
7
7
- [ ] Tag and create a release to create a Zenodo version and DOI.
8
-
- [ ] Add the badge for pyOpenSci peer-review to the README.md of <package-name-here>. The badge should be `[](https://github.com/pyOpenSci/software-review/issues/issue-number)`
9
-
- [ ] Add <package-name> to the pyOpenSci website. <maintainer-name>, please open a pr to update [this file](https://github.com/pyOpenSci/pyopensci.github.io/blob/main/_data/packages.yml): to add your package and name to the list of contributors
8
+
- [ ] Add the badge for pyOpenSci peer-review to the README.md of <package-name-here>. The badge should be `[](https://github.com/pyOpenSci/software-review/issues/issue-number)`.
9
+
- [ ] Add <package-name> to the pyOpenSci website. <maintainer-name>, please open a pr to update [this file](https://github.com/pyOpenSci/pyopensci.github.io/blob/main/_data/packages.yml): to add your package and name to the list of contributors.
10
10
- [ ] <reviewers-and-maintainers> if you have time and are open to being listed on our website, please add yourselves to [this file](https://github.com/pyOpenSci/pyopensci.github.io/blob/main/_data/contributors.yml) via a pr so we can list you on our website as contributors!
11
11
12
12
<IF JOSS SUBMISSION>
13
13
It looks like you would like to submit this package to JOSS. Here are the next steps:
14
14
15
15
- [ ] Login to the JOSS website and fill out the JOSS submission form using your Zenodo DOI. **When you fill out the form, be sure to mention and link to the approved pyOpenSci review.** JOSS will tag your package for expedited review if it is already pyOpenSci approved.
16
-
- [ ] Wait for a JOSS editor to approve the presubmission (which includes a scope check)
16
+
- [ ] Wait for a JOSS editor to approve the presubmission (which includes a scope check).
17
17
- [ ] Once the package is approved by JOSS, you will be given instructions by JOSS about updating the citation information in your README file.
18
18
- [ ] When the JOSS review is complete, add a comment to your review in the pyOpenSci software-review repo that it has been approved by JOSS.
0 commit comments