Skip to content

Commit cc34ab6

Browse files
InessaPawsonlwasser
authored andcommitted
Remove trailing whitespace in policies.md
Removes trailing whitespace in policies.md
1 parent d5674c6 commit cc34ab6

File tree

1 file changed

+64
-64
lines changed

1 file changed

+64
-64
lines changed

our-process/policies.md

Lines changed: 64 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,28 @@
22

33
## Review Process Guidelines
44

5-
pyOpenSci packages are reviewed for quality, fit, scope, documentation, and
6-
usability. The review process is similar to a manuscript review, however, it
5+
pyOpenSci packages are reviewed for quality, fit, scope, documentation, and
6+
usability. The review process is similar to a manuscript review, however, it
77
has a stronger focus on Python packaging best practices.
88

9-
Unlike a manuscript review, our peer review process is an ongoing conversation.
10-
Once all major issues and questions are addressed, the review editor will make
9+
Unlike a manuscript review, our peer review process is an ongoing conversation.
10+
Once all major issues and questions are addressed, the review editor will make
1111
a decision to accept, hold, or reject the package.
1212

13-
Rejections are usually done early in the process, before the review process
14-
begins. In rare cases, a package may also not be on-boarded into the pyOpenSci
13+
Rejections are usually done early in the process, before the review process
14+
begins. In rare cases, a package may also not be on-boarded into the pyOpenSci
1515
ecosystem after review & revision.
1616

17-
It is ultimately the editor’s decision on whether or not to reject the package
17+
It is ultimately the editor’s decision on whether or not to reject the package
1818
based on how the reviews are addressed.
1919

2020
## Review Communication Approach
2121

2222
Communication between authors, reviewers, and editors takes
23-
place on GitHub. You can, however choose to contact the editor by email if
23+
place on GitHub. You can, however choose to contact the editor by email if
2424
needed.
2525

26-
When submitting a package, please make sure that your GitHub notification
26+
When submitting a package, please make sure that your GitHub notification
2727
settings are setup to notify you when you receive feedback on the review issue.
2828

2929
## Submitting Your Package for Review in Other Venues
@@ -34,8 +34,8 @@ submitting a software paper describing the package to a journal.
3434
Review feedback may result in major improvements and updates to your package,
3535
including changes that could be break package functionality.
3636

37-
Applying reviewer or editor recommendations to your package can improve your
38-
users' experience with future versions of your package even if your package is
37+
Applying reviewer or editor recommendations to your package can improve your
38+
users' experience with future versions of your package even if your package is
3939
already published on `PyPI` or `conda-forge`.
4040

4141
> Please do not submit your package for review while it or an associated
@@ -57,8 +57,8 @@ submit it to pyOpenSci for review. This provides:
5757

5858
## Conflict of Interest for Reviews and Editors
5959

60-
Following criteria are meant to be a guide for what constitutes a conflict of
61-
interest (COI) for an editor or reviewer. The potential editor or reviewer has
60+
Following criteria are meant to be a guide for what constitutes a conflict of
61+
interest (COI) for an editor or reviewer. The potential editor or reviewer has
6262
a conflict of interest if:
6363

6464
- The authors with a major role are from the potential reviewer/editor’s
@@ -80,103 +80,103 @@ external guest editor will be recruited to lead the package review.
8080

8181
## Review Timelines and On-Hold Reviews
8282

83-
At any time, an author can choose to have their submission put on hold
84-
(the editor applies the `on-hold` label to the GitHub issue). The `on-hold`
85-
status will be revisited every 3 months. If after one year there has been
83+
At any time, an author can choose to have their submission put on hold
84+
(the editor applies the `on-hold` label to the GitHub issue). The `on-hold`
85+
status will be revisited every 3 months. If after one year there has been
8686
no movement on the review, the issue will be closed.
8787

8888
## After Acceptance: Package Ownership and Maintenance
8989

90-
Package authors are expected to maintain and develop their software and
90+
Package authors are expected to maintain and develop their software and
9191
retain
92-
ownership of it after acceptance into pyOpenSci, as per the peer review
93-
agreement acknowledged upon submission. This maintenance commitment should
94-
last for at least two years. The pyOpenSci team will not interfere with
92+
ownership of it after acceptance into pyOpenSci, as per the peer review
93+
agreement acknowledged upon submission. This maintenance commitment should
94+
last for at least two years. The pyOpenSci team will not interfere with
9595
day-to-day tool maintenance unless explicitly added as collaborators.
9696

97-
If you need to step down from maintaining your accepted pyOpenSci package,
98-
please promptly notify the pyOpenSci Editor-in-Chief or Software Review Lead.
97+
If you need to step down from maintaining your accepted pyOpenSci package,
98+
please promptly notify the pyOpenSci Editor-in-Chief or Software Review Lead.
9999
pyOpenSci will collaborate with you to either:
100100

101101
- Find a new maintainer or
102102
- Archive the tool, depending on what best suits your specific scientific
103103
Python package.
104104

105-
We will reach out to our package maintainers each year to verify the
106-
package is actively maintained and to see if there are any updates we can
105+
We will reach out to our package maintainers each year to verify the
106+
package is actively maintained and to see if there are any updates we can
107107
highlight through our social channels.
108108

109109
### Maintenance Tracking
110110

111-
pyOpenSci is building a system to track package metrics and activity,
112-
including issues, pull requests, and dates of the last release and last commit
113-
to the package repository. Activity is defined as a repository commit, pull
111+
pyOpenSci is building a system to track package metrics and activity,
112+
including issues, pull requests, and dates of the last release and last commit
113+
to the package repository. Activity is defined as a repository commit, pull
114114
request, or release.
115115

116-
We will flag packages that haven't been updated within a 1 year/ 12 month time
117-
period based on activity. Packages with no activity after 12 months will be
118-
flagged. At that time, pyOpenSci editorial team member will contact the package
116+
We will flag packages that haven't been updated within a 1 year/ 12 month time
117+
period based on activity. Packages with no activity after 12 months will be
118+
flagged. At that time, pyOpenSci editorial team member will contact the package
119119
maintainers to evaluate the maintenance status of their package.
120120

121121
(archive-process)=
122122

123123
### Package Maintenance and Maintainer Responsiveness
124124

125-
If, after one year, package maintainers are unresponsive to requests for
126-
package fixes or messages from the pyOpenSci team, we will initiate
127-
discussions about the package's ongoing inclusion within the pyOpenSci
125+
If, after one year, package maintainers are unresponsive to requests for
126+
package fixes or messages from the pyOpenSci team, we will initiate
127+
discussions about the package's ongoing inclusion within the pyOpenSci
128128
ecosystem.
129129

130-
In cases where a package is heavily used by the community, we may
131-
collaborate with the community to identify reasonable next steps, such as
132-
assisting in finding a new maintainer. If a solution for ongoing package
133-
maintenance is not found, the package will be archived within the pyOpenSci
130+
In cases where a package is heavily used by the community, we may
131+
collaborate with the community to identify reasonable next steps, such as
132+
assisting in finding a new maintainer. If a solution for ongoing package
133+
maintenance is not found, the package will be archived within the pyOpenSci
134134
ecosystem.
135135

136136
If a sub-community decides to fork and maintain the package, we are open to
137-
working with the new maintainers to register the newly forked package within
138-
our ecosystem. The original package will be archived with a link to the new
137+
working with the new maintainers to register the newly forked package within
138+
our ecosystem. The original package will be archived with a link to the new
139139
fork.
140140

141141
### Quality Commitment
142142

143-
pyOpenSci strives to develop and promote high quality research software. To
144-
ensure that your software meets our criteria, we review all of our submissions
145-
as part of the Software Peer Review process. We expect that you will continue
143+
pyOpenSci strives to develop and promote high quality research software. To
144+
ensure that your software meets our criteria, we review all of our submissions
145+
as part of the Software Peer Review process. We expect that you will continue
146146
to maintain a package that has been accepted continually.
147147

148-
Despite our best efforts to support contributed software, errors are the
149-
responsibility of individual maintainers. Buggy, unmaintained software may
150-
be removed from our suite at any time. We also ask maintainers that they get
148+
Despite our best efforts to support contributed software, errors are the
149+
responsibility of individual maintainers. Buggy, unmaintained software may
150+
be removed from our suite at any time. We also ask maintainers that they get
151151
in touch with us if they do need to step down from maintaining a tool.
152152

153153
### Requesting Package Removal from the pyOpenSci Ecosystem
154154

155-
In the unlikely scenario that a contributor of a package requests removal of
156-
their package from our ecosystem, we retain the right offer the last / most
157-
recently released version of that package in our ecosystem for archival
155+
In the unlikely scenario that a contributor of a package requests removal of
156+
their package from our ecosystem, we retain the right offer the last / most
157+
recently released version of that package in our ecosystem for archival
158158
purposes only.
159159

160160
### Archiving a Package
161161

162-
If a package appears to be no longer maintained, we may move to mark it as
163-
archived which moves the package from our
164-
[main package listing](https://www.pyopensci.org/python-packages.html#all-packages)
165-
to our [archived packaging](https://www.pyopensci.org/python-packages.html#archived-packages)
162+
If a package appears to be no longer maintained, we may move to mark it as
163+
archived which moves the package from our
164+
[main package listing](https://www.pyopensci.org/python-packages.html#all-packages)
165+
to our [archived packaging](https://www.pyopensci.org/python-packages.html#archived-packages)
166166
listing section.
167167

168-
To archive a pyOpenSci approved package, add the
169-
[archive label](https://github.com/pyOpenSci/software-submission/issues?q=label%3Aarchived)
170-
to the original review issue. Once this label is applied to the issue, the
171-
website will automatically update to reflect this status. If at any point
172-
in the future, an archived package undergoes active maintenance again, this
173-
label can be removed from the issue to move the package back to an active
168+
To archive a pyOpenSci approved package, add the
169+
[archive label](https://github.com/pyOpenSci/software-submission/issues?q=label%3Aarchived)
170+
to the original review issue. Once this label is applied to the issue, the
171+
website will automatically update to reflect this status. If at any point
172+
in the future, an archived package undergoes active maintenance again, this
173+
label can be removed from the issue to move the package back to an active
174174
status.
175175

176-
We opt to archive inactive packages rather than remove them to preserve the
177-
history and contributions of the software, ensuring that others can still
178-
access and learn from it. This approach maintains the integrity of the
179-
scientific record and allows for potential future reactivation or forking
180-
of the project. By archiving rather than removing, we provide a clear
181-
status of the package while keeping its legacy intact for reference and
176+
We opt to archive inactive packages rather than remove them to preserve the
177+
history and contributions of the software, ensuring that others can still
178+
access and learn from it. This approach maintains the integrity of the
179+
scientific record and allows for potential future reactivation or forking
180+
of the project. By archiving rather than removing, we provide a clear
181+
status of the package while keeping its legacy intact for reference and
182182
educational purposes.

0 commit comments

Comments
 (0)