Update: New submission form #113
Conversation
| @@ -1,39 +1,210 @@ | |||
| name: DRAFT WIP from a SPRINT - PLEASE DO NOT USE THIS TEMPLATE | |||
| name: Submit Software for Review (Draft) | |||
There was a problem hiding this comment.
| name: Submit Software for Review (Draft) | |
| name: Submit You Package to pyOpenSci for Review |
| @@ -1,39 +1,210 @@ | |||
| name: DRAFT WIP from a SPRINT - PLEASE DO NOT USE THIS TEMPLATE | |||
| name: Submit Software for Review (Draft) | |||
| description: Use to submit your Python package for pyOpenSci peer review | |||
There was a problem hiding this comment.
| description: Use to submit your Python package for pyOpenSci peer review | |
| description: Use this form to submit your Python package to the pyOpenSci peer review process. If you run into any issues with the form, you can ask questions [on our discourse forum here](https://pyopensci.discourse.group/c/review-process/7). |
| body: | ||
| - type: input | ||
| id: "Submitting_Author" | ||
| id: "submitting_author" | ||
| attributes: | ||
| label: Submitting Author |
There was a problem hiding this comment.
For each person we want two fields.
- the persons first and last name
- the persons github handle
if they are separate it will be much easier for me to parse!
so for each form field i'd also provide an example of the format we expect like this:
Submiting author first and last name (e.g. Janet Doe)
| label: Current Maintainers | ||
| description: list all current maintainers | ||
| placeholder: github_handle1, github_handle2 | ||
| label: Maintainer 1 |
There was a problem hiding this comment.
Same as above let's have first and last name and then the github handle for each maintainer.
Let's also allow for up to 5 maintainers and then an open ended box for any additional maintainers they wish to add.
| placeholder: Package name here | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: "One_line_desc" | ||
| id: "one_line_desc" | ||
| attributes: | ||
| label: One-Line Description of Package |
There was a problem hiding this comment.
| label: One-Line Description of Package | |
| label: One-Line Description of Package (please try to avoid using overly technical terms if possible for this one line entry) |
There was a problem hiding this comment.
ideally they avoid jargon so we can use this in our social media from the start! we could also say "please provide and easy-to-understand one-line description of your package here"
| label: Repository Link | ||
| description: Link to the package repository | ||
| placeholder: Link here |
There was a problem hiding this comment.
| label: Repository Link | |
| description: Link to the package repository | |
| placeholder: Link here | |
| label: Repository Link | |
| description: Please provide a link to your package's GitHub / GitLab repository. | |
| placeholder: Repository link here |
There was a problem hiding this comment.
i think this is what the user sees? is the description under the label?
| placeholder: Link here | ||
| validations: | ||
| required: true | ||
| - type: input |
There was a problem hiding this comment.
please have them add the version number submitted and ALSO a link to that version of the repo so it would either be a link to a tag/ release or a commit value. so there should be two fields here.
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| id: terms | ||
| attributes: |
| - label: I expect to maintain this package for at least 2 years and can help find a replacement for the maintainer (team) if needed. | ||
| required: true |
There was a problem hiding this comment.
| - label: I expect to maintain this package for at least 2 years and can help find a replacement for the maintainer (team) if needed. | |
| required: true | |
| - label: I expect to maintain this package for at least 2 years. In the case that I need to step down as a maintainer, i'm open to supporting finding a replacement maintainer (team) if needed / if it makes sense for my package. | |
| required: true |
| - label: I have read the [author guide](https://www.pyopensci.org/software-peer-review/how-to/author-guide.html). | ||
| required: true | ||
| - type: textarea |
There was a problem hiding this comment.
| - label: I have read the [author guide](https://www.pyopensci.org/software-peer-review/how-to/author-guide.html). | |
| required: true | |
| - type: textarea | |
| - label: I have read the [pyOS peer review author guide](https://www.pyopensci.org/software-peer-review/how-to/author-guide.html). | |
| required: true | |
| - type: textarea |
| label: Description | ||
| description: Include a brief paragraph describing what your package does | ||
| placeholder: Description here | ||
| validations: |
There was a problem hiding this comment.
| label: Description | |
| description: Include a brief paragraph describing what your package does | |
| placeholder: Description here | |
| validations: | |
| label: Description | |
| description: Please provide a brief and easy-to-understand paragraph describing what your package does. Please try to avoid jargon or define jargon to make it clear to our cross-domain editorial team what your package does. | |
| placeholder: Easy-to-understand package description here. | |
| validations: |
| description: "Please select one or more categories. Check out our [package scope page](https://www.pyopensci.org/software-peer-review/about/package-scope.html) to learn more about our scope. (If you are unsure of which category you fit, we suggest you make a pre-submission inquiry):" | ||
| options: |
There was a problem hiding this comment.
| description: "Please select one or more categories. Check out our [package scope page](https://www.pyopensci.org/software-peer-review/about/package-scope.html) to learn more about our scope. (If you are unsure of which category you fit, we suggest you make a pre-submission inquiry):" | |
| options: | |
| description: "Please select one or more categories. Check out our [package scope page](https://www.pyopensci.org/software-peer-review/about/package-scope.html) to learn more about our scope. (If you are unsure of which category you fit, we suggest that you make a pre-submission inquiry):" | |
| options: |
| - label: Database interoperability | ||
| - type: checkboxes | ||
| id: "partnerships" | ||
| attributes: |
There was a problem hiding this comment.
@juanis2112 can we add markdown to this form to break up sections with lines / rules? that would be great for this section. i want to add some clarifying language here and also we will have more communities in the future coming on board so i want to ensure that this section is flexible.
| - type: checkboxes | ||
| id: "partnerships" | ||
| attributes: | ||
| label: Domain Specific & Community Partnerships |
There was a problem hiding this comment.
ok so right now this section i know is confusing for users. so let's break it up. let's add
Does your package fit into the categories below? (this is optional - it is ok if it doesn't. We use this information to help our package users find packages with functionality that they need).
- geospatial
- education
SO then let's add a section called community partnerships like this:
## Community partnerships
pyOpenSci [partners with communities](https://www.pyopensci.org/software-peer-review/partners/scientific-communities.html#pyopensci-software-peer-review-partnerships) that are maintaining lists of affiliated packages. You do not need to be a part of a community or to fall into a specific domain to apply for peer review. However if you are a part of the community we will vet your tool against both our pyOpenSci standards and the community specific standards.
I would like to be affiliated with a community listed below. (check the box if you believe meet the community affiliation requirements):
- I wish to be considered to be Pangeo affiliated. I have [read the pangeo requirements](https://www.pyopensci.org/software-peer-review/partners/pangeo.html#pangeo-specific-software-peer-review-guidelines) and believe my package follows them.
if this is confusing language we can reword - but i'd like this to be a section so we can just add communities as they come onboard and direct authors to the requirements for that community. but we also want to be clear that people don't HAVE to be a part of the community to go into review (i've been asked this a few times hence i'd like to add text that this is OPTIONAL)
| - type: textarea | ||
| id: "category_explanation" | ||
| attributes: | ||
| label: Category explanation |
There was a problem hiding this comment.
i wonder if we want to make this three boxes so it's super clear and easy to fill out.
Package scope questions
- Please describe the target audience of this package
- what are the scientific applications of this package
- Are there any other python packages that accomplish the same thing? (yes / no)
- if yes - provide a box to explain what packages and why
- if you made a pre-submission please past the link here.
| label: Technical Checks | ||
| description: "For details about the pyOpenSci packaging requirements, see our [packaging guide](https://www.pyopensci.org/python-package-guide/). Confirm each of the following by checking the box. This package: " | ||
| options: | ||
| - label: does not violate the Terms of Service of any service it interacts with. | ||
| required: false | ||
| - label: "uses an [OSI approved license](https://opensource.org/licenses)." | ||
| required: false |
There was a problem hiding this comment.
| label: Technical Checks | |
| description: "For details about the pyOpenSci packaging requirements, see our [packaging guide](https://www.pyopensci.org/python-package-guide/). Confirm each of the following by checking the box. This package: " | |
| options: | |
| - label: does not violate the Terms of Service of any service it interacts with. | |
| required: false | |
| - label: "uses an [OSI approved license](https://opensource.org/licenses)." | |
| required: false | |
| label: Package Technical Checks | |
| description: "For details about the pyOpenSci packaging requirements, see our [packaging guide](https://www.pyopensci.org/python-package-guide/). Confirm each of the following by checking the box. This package: " | |
| options: | |
| - label: does not violate the Terms of Service of any service it interacts with. | |
| required: false | |
| - label: "uses an [OSI approved license](https://opensource.org/licenses)." | |
| required: false |
| - label: contains a README with instructions for installing the development version. | ||
| required: false |
There was a problem hiding this comment.
| - label: contains a README with instructions for installing the development version. | |
| required: false | |
| - label: contains a README file with instructions for creating an environment for and installing the development version of the package. | |
| required: false |
| - label: includes documentation with examples for all functions. | ||
| required: false | ||
| - label: contains a tutorial with examples of its essential functions and uses. |
There was a problem hiding this comment.
| - label: includes documentation with examples for all functions. | |
| required: false | |
| - label: contains a tutorial with examples of its essential functions and uses. | |
| - label: includes documentation with examples for all functions & methods. (examples in your docstring are optional but encouraged) | |
| required: false | |
| - label: contains a get-started tutorial with examples of using the package's essential functions and applications. |
| - label: has continuous integration setup, such as GitHub Actions, CircleCI, and/or others. | ||
| required: false |
There was a problem hiding this comment.
| - label: has continuous integration setup, such as GitHub Actions, CircleCI, and/or others. | |
| required: false | |
| - label: has continuous integration setup to run tests, such as GitHub Actions, CircleCI, and/or others. | |
| required: false |
| description: "Do you wish to automatically submit to the [Journal of Open Source Software](http://joss.theoj.org/)?" | ||
| options: | ||
| - I want to automatically submit to JOSS. | ||
| - I don't want to automatically submit to JOSS. |
There was a problem hiding this comment.
I think this should be a new section as well. title it
## Journal of Open Source (JOSS) Partnership Submission
pyOpenSci partners with JOSS. This means that JOSS accepts our review as theirs and will only review your paper if your package is within the JOSS scope.
Note that this is not automatic. so removing that language here
| description: "Do you wish to automatically submit to the [Journal of Open Source Software](http://joss.theoj.org/)?" | |
| options: | |
| - I want to automatically submit to JOSS. | |
| - I don't want to automatically submit to JOSS. | |
| description: "Do you wish to submit to the [Journal of Open Source Software](http://joss.theoj.org/) when the pyOS review is complete?" | |
| options: | |
| - I want to submit to JOSS. | |
| - I don't want to submit to JOSS. |
| description: "If you want to automatically submit your package to JOSS, please confirm each of the following by checking the box:" | ||
| options: |
There was a problem hiding this comment.
| description: "If you want to automatically submit your package to JOSS, please confirm each of the following by checking the box:" | |
| options: | |
| description: "JOSS has a slightly more refined scope than that of pyOpenSci. If you want to submit your package to JOSS, please use the links below to determine whether your package is in JOSS' scope. Check each box that applies. NOTE: JOSS will make the final determination of scope into their ecosystem. These checks are here to help prepare you for their process and guidelines. " | |
| options: |
| options: | ||
| - I want to automatically submit to JOSS. | ||
| - I don't want to automatically submit to JOSS. | ||
| validations: |
There was a problem hiding this comment.
In the original issue template we have this section as a section that you can "unfold" if you are interested in JOSS. Can we add that same format to this form?
| - label: "The package is deposited in a long-term repository with the DOI listed below." | ||
| required: false | ||
| - type: input | ||
| id: "package_doi" |
There was a problem hiding this comment.
this should be a new section as well. this is the section that the editor fills out when the review is over. section name:
Post review metadata (to be filled out by an editor)
| required: false | ||
| - label: "The package is deposited in a long-term repository with the DOI listed below." | ||
| required: false | ||
| - type: input | ||
| id: "package_doi" |
There was a problem hiding this comment.
Please add this explanation text to this section:
At the end of our reviews we ask that you create a final tagged release associated with the review that is linked to a zenodo archive (or some other archive of your choice). An editor will ask you to provide that link when the review is complete. The link will be added here.
| attributes: | ||
| label: Feedback | ||
| description: "Have feedback/comments about our review process? Leave a comment the [pyOpenSci Discourse](https://pyopensci.discourse.group/c/review-process/7)." | ||
| options: |
There was a problem hiding this comment.
This feedback portion doesn't have to be a question with a check box - it can just be text at the bottom of the issue.
| required: false | ||
| - type: input | ||
| id: "package_doi" | ||
| attributes: |
There was a problem hiding this comment.
i'd like to add a second link to the JOSS archive IF they submitted to JOSS. again this will be filled in at the END of the review but we like this information at the top of the issue.
so the DOI archive question should be there and then below the JOSS archive (optional and only if they submit to joss)
|
closing this as stale as well |
No description provided.