-
Notifications
You must be signed in to change notification settings - Fork 31
FIX: Update and cleanup the peer review section of our guide #148
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
Merged
Merged
Changes from all commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
231d7f4
rebase
lwasser 49d2c29
rebase 4
lwasser 6acb317
Apply suggestions from code review
lwasser d86db5f
Update appendices/package-approval-template.md
lwasser 382911b
Update appendices/review-template.md
lwasser acfa961
Fix: template name and fix links throughout
lwasser e1a5744
Fix: cleanup review template
lwasser e7a3e4d
Fix: templates and other minor edits
lwasser 421151d
Fix: edits based on reviews
lwasser 1b03ca2
Update software-peer-review-guide/editors-guide.md
lwasser 159e4de
Fix: move scope to appendix
lwasser 7a54949
Add: holding language to editor guide and other edigs
lwasser f7ae35d
Update software-peer-review-guide/editors-guide.md
lwasser aa83dd9
Update software-peer-review-guide/editors-guide.md
lwasser 06722d7
Edits on massive overhaul of peer review guide
lwasser e89d455
Fix JOSS link to criteria and scope
lwasser 796ef98
Update software-peer-review-guide/editors-guide.md
lwasser 7e73a9b
Update software-peer-review-guide/editors-guide.md
lwasser 81f5c0b
Update appendices/review-template.md
lwasser 81fd55c
Update appendices/review-template.md
lwasser 789d05b
Update appendices/review-template.md
lwasser File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,53 +1,60 @@ | ||
|
|
||
| /* HEADER BLOCK */ | ||
| div.header__block { | ||
| color: #222; | ||
| body, p { | ||
| font-size: 1.04em; | ||
| } | ||
|
|
||
| /* not working and not sure why */ | ||
| .caption-text { | ||
|
|
||
| h1, h2, h3 { | ||
| font-family:'Franklin Gothic Medium', Arial, sans-serif; | ||
| font-weight: bold; | ||
| } | ||
|
|
||
| h1 { | ||
| margin-bottom: 1em; | ||
| font-size: 2.5rem; | ||
| } | ||
|
|
||
| /* | ||
| .announcement div { | ||
| background-color: #ccc; | ||
| } */ | ||
| h2 { | ||
| margin-top: 1.7em; | ||
| } | ||
|
|
||
| .header-item.announcement, .header-item.announcement .noprint { | ||
| background-color:#ccc; | ||
| h3, .content-container h3 { | ||
| margin-top: 1.6em!important; | ||
| } | ||
|
|
||
| div .announcement .header-item .noprint, header-item.announcement { | ||
| background-color: #ccc!important; | ||
| ul li p { | ||
| padding-bottom: .8em; | ||
| line-height: 1.5em; | ||
| } | ||
|
|
||
| /* notes */ | ||
| .epigraph { | ||
| font-style: italic; | ||
| border-left: 4px solid #ccc!important; | ||
| margin-left: 0!important; | ||
| font-size: 1.2em!important; | ||
| } | ||
|
|
||
| div.admonition.note .admonition-title, div.admonition.note .admonition-title::before { | ||
| background-color: #C1CFD4; | ||
| div.header__block { | ||
| color: #222; | ||
|
|
||
| } | ||
|
|
||
| div.admonition.note { | ||
| border-color: #C1CFD4; | ||
| background-color: #E3F4FA; | ||
| /* not working and not sure why */ | ||
| .caption-text { | ||
|
|
||
| } | ||
|
|
||
|
|
||
| div.admonition.important .admonition-title, div.admonition.important .admonition-title::before { | ||
| background-color: #107762; | ||
| color: #ffffff!important; | ||
| /* | ||
| .announcement div { | ||
| background-color: #ccc; | ||
| } */ | ||
| /* | ||
| .header-item.announcement, .header-item.announcement .noprint { | ||
| background-color:#ccc; | ||
| } | ||
|
|
||
| div.admonition.important .admonition-title { | ||
| background-color: #107762; | ||
| border-color: #1abc9c; | ||
| div.admonition.note { | ||
| margin-top: 4em; | ||
| margin-bottom: 4em; | ||
| background-color: #F8F9FB | ||
| } | ||
|
|
||
| div.admonition.important { | ||
| border-color: #0e6654; | ||
| background-color: #ecfcf9; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
|
|
||
| - [ ] **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)? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| ```markdown | ||
lwasser marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## Editor in Chief checks | ||
lwasser marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Hi there! Thank you for submitting your package for pyOpenSci | ||
| review. Below are the basic checks that your package needs to pass | ||
| to begin our review. If some of these are missing, we will ask you | ||
| to work on them before the review process begins. | ||
|
|
||
| - [ ] **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). | ||
| - [ ] The package imports properly into a standard Python environment `import package-name`. | ||
| - [ ] **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). | ||
| - [ ] **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: | ||
| - [ ] 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") | ||
| - [ ] 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*. | ||
| - [ ] **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. | ||
| - [ ] **Contributing File** The package has a `CONTRIBUTING.md` file that details how to install and contribute to the package. | ||
| - [ ] **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). | ||
| - [ ] **Automated tests** Package has a testing suite and is tested via GitHub actions or another Continuous Integration service. | ||
| - [ ] **License** The package has an [OSI approved license](https://opensource.org/licenses). | ||
| - [ ] **Repository** The repository link resolves correctly. | ||
| - [ ] **Package overlap** The package doesn't entirely overlap with the functionality of other packages that have already been submitted to pyOpenSci. | ||
| - [ ] **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)? | ||
|
|
||
| --- | ||
| - [ ] [Initial onboarding survey was filled out ](https://forms.gle/F9mou7S3jhe8DMJ16) | ||
| We appreciate each maintainer of the package filling out this survey individually. :raised_hands: | ||
| Thank you authors in advance for setting aside five to ten minutes to do this. It truly helps our organization. :raised_hands: | ||
| --- | ||
|
|
||
| ******* | ||
|
|
||
| ## Editor comments | ||
|
|
||
|
|
||
| ``` | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was just wondering if this wouldn't go against the transparency of the whole process. What do you think @lwasser?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is a great question @arianesasso in some cases I think there is a place for email. Many people miss github "pings" for instance i might have hundreds in a day of emails with github's name on them. Ideally i'd see it but sometimes i dont. So i think it's ok to email people too. but i totally hear your point and like that we can start by pinging on github.
oh another point -- in some cases maybe someone wants to review but they'd like some help or support. it might be more comfortable for them to acknowledge that in an email as well vs in a public issue. So i think there is a place for both! but again excellent insight here :)