Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: update archive package text #258

Merged
merged 12 commits into from
Dec 15, 2023
79 changes: 45 additions & 34 deletions our-process/policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ When submitting a package, please make sure that your GitHub notification settin

We strongly suggest submitting your package for review with pyOpenSci before:

* publishing on `PyPI` or `conda`;
* submitting a software paper describing the package to a journal.
- publishing on `PyPI` or `conda`;
- submitting a software paper describing the package to a journal.

Review feedback may result in major improvements and updates to your package,
including changes that could be break package functionality.
Expand All @@ -34,19 +34,22 @@ We do not consider previous publication on `PyPI` or `conda` or in other venues
sufficient reason to not adopt reviewer or editor recommendations provided in
our review.

>Please do not submit your package for review while it or an associated manuscript is
> Please do not submit your package for review while it or an associated manuscript is
> also under review at another venue, as this may result on conflicting requests
> for changes from two sets of reviewers.

### Publication with Journal of Open Source Software (JOSS)

If you have previously published your software package with JOSS, you can still
submit it to pyOpenSci for review. This provides:

* Increased visibility of your package as a vetted tool within the scientific python ecosystem
* We will also keep in touch with you as a maintainer to support long term maintenance. If you need to step down from maintaining your package we will help find a new maintainer and/or help sunset the tool.
- Increased visibility of your package as a vetted tool within the scientific python ecosystem
- We will also keep in touch with you as a maintainer to support long term maintenance. If you need to step down from maintaining your package we will help find a new maintainer and/or help sunset the tool.

(coi)=

### Conflict of interest for reviews and editors

Following criteria are meant to be a guide for what constitutes a conflict of interest
for an editor or reviewer. The potential editor or reviewer has a conflict of interest
if:
Expand All @@ -65,41 +68,50 @@ external guest editor will be recruited to lead the package review.

## After Acceptance: Package Ownership and Maintenance

Authors of contributed packages essentially maintain the same ownership they
had prior to their package joining the pyOpenSci suite. Package authors will
continue to maintain
and develop their software after acceptance into pyOpenSci. Unless explicitly added as
collaborators, the pyOpenSci team will not interfere with day to day operations.
Package authors are expected to maintain and develop their software and retain
ownership of it after acceptance into pyOpenSci, as per the peer review agreement
acknowledged upon submission. This maintenance commitment should last for at
least two years. The pyOpenSci team will not interfere with day-to-day tool
maintenance unless explicitly added as collaborators.

If you need to step down from maintaining your accepted pyOpenSci package, please
please notify the EiC / software review lead of this as soon as you can. We
will talk with you about your tool and work together to either find a new maintainer or sunset the tool depending upon what makes the most sense.
promptly notify the pyOpenSci Editor-in-Chief or Software Review Lead. pyOpenSci
will collaborate with you to either:

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

We will reach out to our package maintainers each year to check in on how
maintenance is going.
We will reach out to our package maintainers each year to assess the status of
maintenance and to see if there are any updates we can highlight through our social channels.

### Maintainer Responsiveness
If package maintainers do not respond in a timely manner to requests for
package fixes, we will remind the maintainer a number of times. After 3 months
(or shorter time frame, depending on how critical the fix is) we will discuss
the future of the package as a part of our pyOpenSci ecosystem.
### Maintenance Tracking

* If a package becomes completely un-maintained we will highlight that fact and
remove it as a vetted tool in our ecosystem.
* If a sub-community decides to fork and maintain that package we are open to working with the new maintainers to keep the package within our ecosystem.
pyOpenSci is building a system to track package metrics, including issues, pull requests, and dates of
the last release and commits to the package repository. Based on activity in
the repository:

<!-- Should authors abandon the maintenance of an actively used package in our suite,
we will consider petitioning PyPI to transfer package maintainer status to pyOpenSci. -->
- Packages not updated within 6 months will receive a flag on the website in the form of a small icon.
- After a year of no updates, the package will be flagged as potentially
archived. At this point, a member of the pyOpenSci team will contact the
package maintainers to assess the maintenance status and their intentions
regarding the tool.

## Package Maintenance and Maintainer Responsiveness

```{note}
Note from the Executive Director: Please note that we are reviewing the text
below and will be updating our policy
surrounding package quality and long term maintenance in the upcoming weeks
(Fall 2022).
```
If, after one year, package maintainers are unresponsive to requests for package
fixes or messages from the pyOpenSci team, we will initiate discussions about
the package's future within the pyOpenSci ecosystem.

In cases where a package is heavily used by the community, we may collaborate
with the community to identify a new maintainer. Otherwise, the package will be
archived within the pyOpenSci ecosystem.

If a sub-community decides to fork and maintain the package, we are open to
working with the new maintainers to keep the package within our ecosystem.

### Quality Commitment

pyOpenSci strives to develop and promote high quality research software. To ensure that
your software meets our criteria, we review all of our submissions as part of the
Software Peer Review process. We expect that you will continue to maintain a
Expand All @@ -110,9 +122,8 @@ of individual maintainers. Buggy, unmaintained software may be removed from our
any time. We also ask maintainers that they get in touch with us if they do need
to step down from maintaining a tool.

### Requesting package removal from the pyOpenSci ecosystem


### Requesting Package Removal
In the unlikely scenario that a contributor of a package requests removal of their
package from the suite, we retain the right to maintain a version of the package in our
suite for archival purposes.
package from our ecosystem, we retain the right to archive a version of the package in our
ecosystem for archival purposes only.