rebase 3

lwasser · lwasser · commit 62e3df323283 · 2022-12-21T12:40:22.000-07:00
diff --git a/_config.yml b/_config.yml
diff --git a/appendices/editor-checks-template.md b/appendices/editor-checks-template.md
@@ -0,0 +1,21 @@
+```markdown
+## Editor response to review:
+
+---
+
+## Editor comments
+:wave: Hi @reviewer-one and @reviewer-two! Thank you for volunteering to review
+for PyOpenSci! <Add any additional banter here that you wish..>
+
+The following resources will help you complete your review:
+
+1. Here is the **[reviewers guide](https://www.pyopensci.org/contributing-guide/peer-review-guides/reviewer-guide.html)**. This guide contains all of the steps and information needed to complete your review.
+2. Here is the **[review template](https://www.pyopensci.org/contributing-guide/appendices/templates.html#review-template)** that you will need to fill out and submit
+here as a comment, once your review is complete.
+
+Please get in touch with any questions or concerns! Your review is due: <Insert deadline DATE HERE>
+---
+
+Reviewers:
+Due date:
+```
diff --git a/appendices/issue-review-template.md b/appendices/issue-review-template.md
@@ -0,0 +1,22 @@
+```markdown
+---
+name: Submit Software for Review
+about: Use to submit your Python package for pyOpenSci peer review
+title: ''
+labels: 1/editor-checks, New Submission!
+assignees: ''
+---
+Submitting Author: Name (@github_handle)
+All current maintainers: (@github_handle1, @github_handle2)
+Package Name: Package name here
+One-Line Description of Package: Description here 
+Repository Link:  
+Version submitted:   
+Editor: TBD  
+Reviewer 1: TBD  
+Reviewer 2: TBD  
+Archive: TBD  
+Version accepted: TBD 
+Date accepted (month/day/year): TBD
+---
+```
diff --git a/appendices/package-approval-template.md b/appendices/package-approval-template.md
@@ -0,0 +1,24 @@
+```markdown
+----------------------------------------------
+🎉 <package-name-here> has been approved by pyOpenSci! Thank you <maintainer-name-here> for submitting <package-name> and many thanks to <reviewer-names-here> for reviewing this package! 😸  
+
+There are a few things left to do to wrap up this submission:
+- [ ] Activate Zenodo watching the repo if you haven't already done so.
+- [ ] Tag and create a release to create a Zenodo version and DOI.
+- [ ] Add the badge for pyOpenSci peer-review to the README.md of <package-name-here>. The badge should be `[![pyOpenSci](https://tinyurl.com/y22nb8up)](https://github.com/pyOpenSci/software-review/issues/issue-number)`
+- [ ] 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
+- [ ] <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!
+
+<IF JOSS SUBMISSION>
+It looks like you would like to submit this package to JOSS. Here are the next steps:
+
+- [ ] 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.
+- [ ] Wait for a JOSS editor to approve the presubmission (which includes a scope check)
+- [ ] Once the package is approved by JOSS, you will be given instructions by JOSS about updating the citation information in your README file.
+- [ ] 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.
+
+🎉 Congratulations! You are now published with both JOSS and pyOpenSci! 🎉
+<IF JOSS SUBMISSION/>
+
+All -- if you have any feedback for us about the review process please feel free to share it here. We are always looking to improve our process and documentation in the [contributing-guide](https://www.pyopensci.org/contributing-guide). We have also been updating our documentation to improve the process, so all feedback is appreciated!
+```
diff --git a/appendices/reviewer-request-template.md b/appendices/reviewer-request-template.md
@@ -0,0 +1,22 @@
+```markdogn
+Dear [REVIEWER-Name],
+
+Hi, this is [EDITOR-Name]. [FRIENDLY BANTER]. I'm writing to ask if you would be willing to review a package for pyOpenSci. As you probably know, pyOpenSci conducts peer review of Python packages contributed to our collection in a manner similar to journals.
+
+The package, [PACKAGE] by [AUTHOR(S)], does [FUNCTION]. You can find it on GitHub here: [REPO LINK]. We conduct our open review process via GitHub as well, here: [ONBOARDING ISSUE]
+
+If you accept, note that we ask reviewers to complete reviews in three weeks. (We’ve found it takes a similar amount of time to review a package as an academic paper.)
+
+Our [reviewers guide] details what we look for in a package review, and includes links to example reviews. Our standards are detailed in our [packaging guide], and we provide reviewer [template] for you to use. Please make sure you do not have a conflict of interest preventing you from reviewing this package. If you have questions or feedback, feel free to ask me.
+
+{IF APPLICABLE: The authors have also chosen to jointly submit their package to the Journal of Open Source Software, so this package includes a short `paper.md` manuscript describing the software that we ask you include in your review.}
+
+Are you able to review? If you can not, suggestions for alternate reviewers are always helpful. If I don't hear from you within a week, I will assume you are unable to
+review at this time.
+
+Thank you for your time.
+
+Sincerely,
+
+[EDITOR]
+```
diff --git a/appendices/templates.md b/appendices/templates.md
@@ -4,24 +4,7 @@ These are templates to be used by editors and reviewers. When a package is submi
 
 ## Editor's Template
 
-```
-## Editor checks:
-
-- [ ] **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).
-- [ ] **Automated tests:** Package has a testing suite and is tested via Travis-CI or another CI service.
-- [ ] **License:** The package has an OSI accepted license
-- [ ] **Repository:** The repository link resolves correctly
-- [ ] **Archive** (JOSS only, may be post-review): The repository DOI resolves correctly
-- [ ] **Version** (JOSS only, may be post-review): Does the release version given match the GitHub release (v1.0.0)?
-
----
-
-## Editor comments
-
----
-
-Reviewers:
-Due date:
+```{include} editor-checks-template.md
 ```
 
 
@@ -32,27 +15,7 @@ Due date:
 
 Editors may make use of the e-mail template below in recruiting reviewers:
 
-```
-Dear [REVIEWER],
-
-Hi, this is [EDITOR]. [FRIENDLY BANTER]. I'm writing to ask if you would be willing to review a package for pyOpenSci. As you probably know, pyOpenSci conducts peer review of Python packages contributed to our collection in a manner similar to journals.
-
-The package, [PACKAGE] by [AUTHOR(S)], does [FUNCTION]. You can find it on GitHub here: [REPO LINK]. We conduct our open review process via GitHub as well, here: [ONBOARDING ISSUE]
-
-If you accept, note that we ask reviewers to complete reviews in three weeks. (We’ve found it takes a similar amount of time to review a package as an academic paper.)
-
-Our [reviewers guide] details what we look for in a package review, and includes links to example reviews. Our standards are detailed in our [packaging guide], and we provide reviewer [template] for you to use. Please make sure you do not have a conflict of interest preventing you from reviewing this package. If you have questions or feedback, feel free to ask me.
-
-{IF APPLICABLE: The authors have also chosen to jointly submit their package to the Journal of Open Source Software, so this package includes a short `paper.md` manuscript describing the software that we ask you include in your review.}
-
-Are you able to review? If you can not, suggestions for alternate reviewers are always helpful. If I don't hear from you within a week, I will assume you are unable to
-review at this time.
-
-Thank you for your time.
-
-Sincerely,
-
-[EDITOR]
+```{include} reviewer-request-template.md
 ```
 
 [reviewers guide]: https://www.pyopensci.org/contributing-guide/peer-review-guides/reviewer-guide.html
diff --git a/conf.py b/conf.py
@@ -41,6 +41,7 @@
 
 # colon fence for card support in md
 myst_enable_extensions = ["colon_fence"]
+myst_heading_anchors = 3
 
 # For generating sitemap
 html_baseurl = 'https://www.pyopensci.org/peer-review-guide/'
diff --git a/index.md b/index.md
@@ -129,6 +129,7 @@ Reviewer Guide <software-peer-review-guide/reviewer-guide>
 Editor Guide <software-peer-review-guide/editors-guide>
 Editor in Chief Guide <software-peer-review-guide/editor-in-chief-guide>
 Onboarding Guide <software-peer-review-guide/onboarding-guide>
+Where to Find Reviewers <software-peer-review-guide/where-to-find-python-package-reviewers>
 ```
 
 ```{toctree}
diff --git a/software-peer-review-guide/editors-guide.md b/software-peer-review-guide/editors-guide.md
diff --git a/software-peer-review-guide/where-to-find-python-package-reviewers.md b/software-peer-review-guide/where-to-find-python-package-reviewers.md
