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.

Sign up for GitHub

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

Jump to bottom

Add: new page on review triage team #249

Merged
merged 3 commits into from
Aug 23, 2023
Merged

Add: new page on review triage team #249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
147552c
Add: new page on review triage team
lwasser Aug 22, 2023
5796683
Fix: add alt tags to all images on page
lwasser Aug 23, 2023
0566aea
fix: ignore 200 errors
lwasser Aug 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 47 additions & 47 deletions .github/workflows/build-book.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,58 +11,58 @@ jobs:
build-test-book:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v2

- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: '3.9'
- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: "3.9"

- name: Upgrade pip
run: |
# install pip=>20.1 to use "pip cache dir"
python3 -m pip install --upgrade pip
- name: Get pip cache dir
id: pip-cache
run: echo "::set-output name=dir::$(pip cache dir)"
- name: Upgrade pip
run: |
# install pip=>20.1 to use "pip cache dir"
python3 -m pip install --upgrade pip
- name: Get pip cache dir
id: pip-cache
run: echo "::set-output name=dir::$(pip cache dir)"

- name: Cache dependencies
uses: actions/cache@v2
with:
path: ${{ steps.pip-cache.outputs.dir }}
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Cache dependencies
uses: actions/cache@v2
with:
path: ${{ steps.pip-cache.outputs.dir }}
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-

- name: Install dependencies
run: python3 -m pip install nox
- name: Install dependencies
run: python3 -m pip install nox

- name: Build book
run: nox -s docs
- name: Build book
run: nox -s docs

# Push the book's HTML to github-pages
- name: Push to GitHub Pages
# Only push if on main branch
if: github.ref == 'refs/heads/main'
uses: peaceiris/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: "./_build/html"
# Push the book's HTML to github-pages
- name: Push to GitHub Pages
# Only push if on main branch
if: github.ref == 'refs/heads/main'
uses: peaceiris/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: "./_build/html"

# Test for bad links and ensure alt tags for usability
- name: Check HTML using htmlproofer
uses: chabad360/htmlproofer@master
with:
directory: ./_build/html
arguments: |
--ignore-files "/.+\/_static\/.+/"
--ignore-status-codes "403, 503"
--ignore-urls "https://github.com/pyOpenSci/software-review/issues/18#issuecomment-581752433"
# Test for bad links and ensure alt tags for usability
- name: Check HTML using htmlproofer
uses: chabad360/htmlproofer@master
with:
directory: ./_build/html
arguments: |
--ignore-files "/.+\/_static\/.+/"
--ignore-status-codes "403, 503, 200"
--ignore-urls "https://github.com/pyOpenSci/software-review/issues/18#issuecomment-581752433"

# Save html as artifact
- name: Save book html as artifact for viewing
uses: actions/upload-artifact@v3
with:
name: book-html
path: |
./_build/html
# Save html as artifact
- name: Save book html as artifact for viewing
uses: actions/upload-artifact@v3
with:
name: book-html
path: |
./_build/html
62 changes: 31 additions & 31 deletions how-to/author-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Author Guide <self>
Reviewer Guide <reviewer-guide>
Editor Guide <editors-guide>
Editor-in-Chief Guide <editor-in-chief-guide>
Triage Team Guide <review-triage-team>

```

Expand All @@ -25,7 +26,6 @@ to submit a package to pyOpenSci for peer review.

Before you begin this process, [please be sure to read the review process guidelines](../our-process/policies).


```{note}
**Before you consider submitting to us please consider the following:**

Expand All @@ -37,6 +37,7 @@ Please be considerate when engaging with everyone online.
```

## 1. Do you plan to continue to maintain your package?

One of the goals of pyOpenSci is to maintain a curated list of
community-approved, maintained and vetted tools that support open science workflows.

Expand All @@ -49,18 +50,16 @@ is complete.
If that maintenance commitment is too much, you might consider submitting
your package to a journal that is more focused on publication only.



### Who should submit the package for review?

If you have a team of people maintaining your package, please be sure
that the submitting author is the person who "owns" or leads that maintenance.
That person will become the long term point of contact
for pyOpenSci.
* Please also include the names of all maintainers on the project
as we also want to ensure that everyone working on the project receives full credit
for their effort.

- Please also include the names of all maintainers on the project
as we also want to ensure that everyone working on the project receives full credit
for their effort.

```{note}
If your package is more of a tool to support a specific workflow that
Expand All @@ -75,6 +74,7 @@ publication quality and citation / credit.
```

## 2. Does Your Package Meet Packaging Requirements?

Before submitting your project for review with pyOpenSci, make sure that
your package meets all of the requirements listed in the editor checks (see below).
We use these checks as a baseline for all submissions and pre-submissions to
Expand All @@ -84,19 +84,13 @@ If you have questions about any of the elements listed below, you can
check out our [pyOpenSci Python packaging guide](https://www.pyopensci.org/python-package-guide) which includes an overview discussion of best practices
for Python packaging including discussions of:

* Tools that you can use to create your package
* Tools for creating and publishing documentation.
* Resources for creating files such as the README file, code of conduct, contributing guide and more.

```{note}
This document is under construction currently (Jan 2023). It should be completed
by the end of Spring 2023.
```

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

```{include} ../appendices/editor-in-chief-checks.md
```

```

```{hint}
**Do you have questions about Python packaging or our peer review process?**
Expand All @@ -118,26 +112,31 @@ Python package.
```

## 3. Is Your Package in Scope for pyOpenSci?

Next, check to see if your package falls within the topical and technical scope of pyOpenSci. If you aren't
sure about whether your package fits within pyOpenSci's scope (below), submit
a [presubmission inquiry issue on the software-review](https://github.com/pyOpenSci/software-review/issues/new?assignees=&labels=0%2Fpresubmission&template=presubmission-inquiry.md&title=)
repository. After you submit an inquiry, a pyOpenSci editor will provide feedback regarding the fit of your package for pyOpenSci review. This can take
up to a week.

Our current categories for determining package scope are below:

<!-- colors https://github.com/pydata/pydata-sphinx-theme/blob/main/src/pydata_sphinx_theme/assets/styles/variables/_color.scss-->

```{button-link} ../about/package-scope.html
:color: primary
:class: sd-rounded-pill
Click here to view our technical and domain scope requirements.
```

## 4. Submit Your Package for Peer Review

To submit your package for peer review, you can
open an issue in our [pyopensci/software-review repo](https://github.com/pyOpenSci/software-review/issues/new/choose/)
repository and fill out the [Submit Software for Review](https://github.com/pyOpenSci/software-review/issues/new?assignees=&labels=1%2Feditor-checks%2C+New+Submission%21&template=submit-software-for-review.md&title=) issue template.

## 5. Editor-in-Chief Reviews Package for Scope and Minimal Infrastructure Criteria

Once the issue is opened, our editor-in-chief and an editor from our editorial board will review your submission within
**2 weeks** and respond with next steps. The editor may request that you make updates
to your package to meet minimal criteria before review. They may also reject your
Expand All @@ -150,6 +149,7 @@ Click here to view the editor checks that will be used to evaluate your package.
```

## 6. The Review Begins

If your package meets minimal criteria for being
reviewed it may then be given to an editor with appropriate domain experience
to manage the review process. That editor will assign 2-3 reviewers to review your
Expand All @@ -159,13 +159,15 @@ We prefer issues that link back to the review as they document changes made to y
package that were triggered by our review process.

## 7. Response to Reviews

You should respond to reviewers’ comments within **2 weeks** of the
last-submitted review. You can make updates to your package at any time. We
encourage ongoing conversations between authors and reviewers. See the
[guide for package reviewers](reviewer-guide.md) for more details about reviewers engagement with package
maintainers during a review.

## 8. Acceptance into pyOpenSci

Once the reviewers are happy with changes that you've made to the package, the
editor will review everything and accept your package into the pyOpenSci ecosystem.
Congratulations! You are almost done!
Expand All @@ -176,17 +178,15 @@ Congratulations on being accepted into the pyOpenSci community of maintainers!
Once your package is approved, a few things will happen:

1. We will ask you to ensure that your package is being tracked / archived using
Zenodo. You will then want to created a tagged release representing the version of the
package accepted by pyOpenSci.
Zenodo. You will then want to created a tagged release representing the version of the
package accepted by pyOpenSci.
1. We will ask you to add the pyOpenSci badge [![pyOpenSci](https://tinyurl.com/y22nb8up)](https://github.com/pyOpenSci/software-review/issues/issue-number) to the
top of your **README.md** file.
top of your **README.md** file.
1. We will ask you to add your package to the [pyOpenSci website](https://www.pyopensci.org/our-community/). This will give
your package more visibility in the community as a vetted pyOpenSci tool.
* We also will ask you (and those who reviewed your package) to add yourself to our list of [pyOpenSci community members](https://www.pyopensci.org/our-community/)!
your package more visibility in the community as a vetted pyOpenSci tool. \* We also will ask you (and those who reviewed your package) to add yourself to our list of [pyOpenSci community members](https://www.pyopensci.org/our-community/)!
1. We will promote your package on our social media channels!
1. We will invite you to write a blog on our website spotlighting your package. The blogs that our maintainers write are some of the most popular content on the website!


If you wish to go on to submit your package to JOSS, you can do so now. Remember that JOSS will accept our review as theirs so you DO NOT need to go through another review. Read more below.

### Journal of Open Source Software (JOSS) Submission
Expand All @@ -195,15 +195,15 @@ PyOpenSci has a partnership with JOSS where our review is accepted by JOSS by
default if the package fits into the JOSS scope.

- When you submit your package for pyOpenSci review, you can opt to include a
submission to JOSS after passing pyOpenSci review. In this case, your package
will evaluated by JOSS through the pyOpenSci review
submission to JOSS after passing pyOpenSci review. In this case, your package
will evaluated by JOSS through the pyOpenSci review
- To complete the JOSS submission, you will also need to craft a **paper.md**
file describing the package following JOSS' standards (see below). More detail on the requirements for JOSS can be found on [their website](https://joss.readthedocs.io/en/latest/submitting.html#what-should-my-paper-contain).
file describing the package following JOSS' standards (see below). More detail on the requirements for JOSS can be found on [their website](https://joss.readthedocs.io/en/latest/submitting.html#what-should-my-paper-contain).
- If you choose to opt into the pyOpenSci / JOSS partnership in your review,
you DO NOT need to go through a second review with JOSS. JOSS accepts our review
for theirs. Please start a review process with JOSS and reference the pyOpenSci
review issue where your package was accepted. Make sure
that you let the JOSS editor know that we have already accepted your package. The JOSS editor will review your paper and once that is accepted you now have a JOSS DOI and badge to display on your README file as well!
you DO NOT need to go through a second review with JOSS. JOSS accepts our review
for theirs. Please start a review process with JOSS and reference the pyOpenSci
review issue where your package was accepted. Make sure
that you let the JOSS editor know that we have already accepted your package. The JOSS editor will review your paper and once that is accepted you now have a JOSS DOI and badge to display on your README file as well!

```{note}
Acceptance to pyOpenSci does not guarantee acceptance to JOSS. In particular,
Expand All @@ -226,8 +226,8 @@ If at any time, you need to step down from maintaining your package,
or you need help with maintenance, please let us know - preferably
in advance. We will try to help you by either:

* Finding a new maintainer to take over your project (or additional maintainers to support maintenance) or
* Sunsetting your package.
- Finding a new maintainer to take over your project (or additional maintainers to support maintenance) or
- Sunsetting your package.

If the package is sunsetted, we will remove it from our curated list
of vetted tools.
Expand Down
Loading
Loading