From 13d49f0b190b96f740fd0c5e7cfe6de104753a1a Mon Sep 17 00:00:00 2001 From: Eliot Robson Date: Thu, 21 May 2026 01:42:17 -0400 Subject: [PATCH] Convert submission template to issue form --- .../submit-software-for-review.md | 151 ------------ .../submit-software-for-review.yml | 228 ++++++++++++++++++ .github/workflows/pycmdcheck-triage.yml | 24 +- 3 files changed, 250 insertions(+), 153 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/submit-software-for-review.md create mode 100644 .github/ISSUE_TEMPLATE/submit-software-for-review.yml diff --git a/.github/ISSUE_TEMPLATE/submit-software-for-review.md b/.github/ISSUE_TEMPLATE/submit-software-for-review.md deleted file mode 100644 index dc94b2e..0000000 --- a/.github/ISSUE_TEMPLATE/submit-software-for-review.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -name: Submit Software for Review -about: Use to submit your Python package for pyOpenSci peer review -title: '' -labels: 0/pre-review-checks, New Submission! -assignees: '' - ---- - -Submitting Author: (@github_handle) -All current maintainers: (@github_handle1, @github_handle2) -Package Name: Package name here -One-Line Description of Package: Description here -Repository Link: https://github.com/owner/repo -Version submitted: v0.1.0 -EiC: TBD -Editor: TBD -Reviewer 1: TBD -Reviewer 2: TBD -Archive: TBD -JOSS DOI: TBD -Version accepted: TBD -Date accepted (month/day/year): TBD - ---- - -## Code of Conduct & Commitment to Maintain Package - -- [ ] I agree to abide by [pyOpenSci's Code of Conduct][PyOpenSciCodeOfConduct] during the review process and in future interactions in spaces supported by pyOpenSci should it be accepted. -- [ ] I have read and will commit to package maintenance after the review as per the [pyOpenSci Policies Guidelines][Commitment]. - -## Description - -- Include a brief paragraph describing what your package does: - - -## Scope - -- Please indicate which category or categories. -Check out our [package scope page][PackageCategories] to learn more about our -scope. (If you are unsure of which category you fit, we suggest you make a pre-submission inquiry): - - - [ ] Data retrieval - - [ ] Data extraction - - [ ] Data processing/munging - - [ ] Data deposition - - [ ] Data validation and testing - - [ ] Data visualization[^1] - - [ ] Workflow automation - - [ ] Citation management and bibliometrics - - [ ] Scientific software wrappers - - [ ] Database interoperability - -## Domain Specific - -- [ ] Geospatial -- [ ] Education - -## Community Partnerships -If your package is associated with an -existing community please check below: - -- [ ] Astropy:[My package adheres to Astropy community standards](https://www.pyopensci.org/software-peer-review/partners/astropy.html) -- [ ] Pangeo: My package adheres to the [Pangeo standards listed in the pyOpenSci peer review guidebook][PangeoCollaboration] - -> [^1]: Please fill out a pre-submission inquiry before submitting a data visualization package. - -- **For all submissions**, explain how and why the package falls under the categories you indicated above. In your explanation, please address the following points (briefly, 1-2 sentences for each): - - - Who is the target audience and what are scientific applications of this package? - - - Are there other Python packages that accomplish the same thing? If so, how does yours differ? - - - If you made a pre-submission enquiry, please paste the link to the corresponding issue, forum post, or other discussion, or `@tag` the editor you contacted: - -## Technical checks - -For details about the pyOpenSci packaging requirements, see our [packaging guide][PackagingGuide]. Confirm each of the following by checking the box. This package: - -- [ ] does not violate the Terms of Service of any service it interacts with. -- [ ] uses an [OSI approved license][OsiApprovedLicense]. -- [ ] contains a README with instructions for installing the development version. -- [ ] includes documentation with examples for all functions. -- [ ] contains a tutorial with examples of its essential functions and uses. -- [ ] has a test suite. -- [ ] has continuous integration setup, such as GitHub Actions CircleCI, and/or others. - -## Publication Options - -- [ ] Do you wish to automatically submit to the [Journal of Open Source Software][JournalOfOpenSourceSoftware]? If so: - -
- JOSS Checks - -- [ ] The package has an **obvious research application** according to JOSS's definition in their [submission requirements][JossSubmissionRequirements]. Be aware that completing the pyOpenSci review process **does not** guarantee acceptance to JOSS. Be sure to read their submission requirements (linked above) if you are interested in submitting to JOSS. -- [ ] The package is not a "minor utility" as defined by JOSS's [submission requirements][JossSubmissionRequirements]: "Minor ‘utility’ packages, including ‘thin’ API clients, are not acceptable." pyOpenSci welcomes these packages under "Data Retrieval", but JOSS has slightly different criteria. -- [ ] The package contains a `paper.md` matching [JOSS's requirements][JossPaperRequirements] with a high-level description in the package root or in `inst/` by the time you wish to submit to JOSS. -- [ ] The package is deposited in a long-term repository with the DOI: - -*Note: JOSS accepts our review as theirs. You will NOT need to go through another full review. JOSS will only review your paper.md file. Be sure to link to this pyOpenSci issue when a JOSS issue is opened for your package. Also be sure to tell the JOSS editor that this is a pyOpenSci reviewed package once you reach this step. Please note that the PyOpenSci reviewers will not be reviewing the paper.md file* - -
- -## Are you OK with Reviewers Submitting Issues and/or pull requests to your Repo Directly? -This option will allow reviewers to open smaller issues that can then be linked to PR's rather than submitting a more dense text based review. It will also allow you to demonstrate addressing the issue via PR links. - -- [x] Yes I am OK with reviewers submitting requested changes as issues to my repo. Reviewers will then link to the issues in their submitted review. - -Confirm each of the following by checking the box. - -- [ ] I have read the [author guide](https://www.pyopensci.org/software-peer-review/how-to/author-guide.html). -- [ ] I expect to maintain this package for at least 2 years and can help find a replacement for the maintainer (team) if needed. - -## Please fill out our survey - -- [ ] [Last but not least please fill out our pre-review survey](https://forms.gle/F9mou7S3jhe8DMJ16). This helps us track -submission and improve our peer review process. We will also ask our reviewers -and editors to fill this out. - -**P.S.** Have feedback/comments about our review process? Leave a comment [on our GitHub Discussions][Comments] - -## Editor and Review Templates - -The [editor template can be found here][Editor Template]. - -The [review template can be found here][Review Template]. - -[PackagingGuide]: https://www.pyopensci.org/python-package-guide/ - -[PackageCategories]: https://www.pyopensci.org/software-peer-review/about/package-scope.html - -[JournalOfOpenSourceSoftware]: http://joss.theoj.org/ - -[JossSubmissionRequirements]: https://joss.readthedocs.io/en/latest/submitting.html#submission-requirements - -[JossPaperRequirements]: https://joss.readthedocs.io/en/latest/submitting.html#what-should-my-paper-contain - -[PyOpenSciCodeOfConduct]: https://www.pyopensci.org/handbook/CODE_OF_CONDUCT.html - -[OsiApprovedLicense]: https://opensource.org/licenses - -[Editor Template]: https://www.pyopensci.org/software-peer-review/appendices/templates.html#editor-s-template - -[Review Template]: https://www.pyopensci.org/software-peer-review/appendices/templates.html#peer-review-template - -[Comments]: https://github.com/orgs/pyOpenSci/discussions - -[PangeoCollaboration]: https://www.pyopensci.org/software-peer-review/partners/pangeo - -[pangeoWebsite]: https://www.pangeo.io -[Commitment]: https://www.pyopensci.org/software-peer-review/our-process/policies.html#after-acceptance-package-ownership-and-maintenance diff --git a/.github/ISSUE_TEMPLATE/submit-software-for-review.yml b/.github/ISSUE_TEMPLATE/submit-software-for-review.yml new file mode 100644 index 0000000..c111eb3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/submit-software-for-review.yml @@ -0,0 +1,228 @@ +name: Submit Software for Review +description: Use to submit your Python package for pyOpenSci peer review +title: "[Submission]: " +labels: + - 0/pre-review-checks + - New Submission! +body: + - type: markdown + attributes: + value: | + Thanks for submitting your package to pyOpenSci. + + Please complete each section below. This form collects the information needed for editorial review and for automated triage checks. + + - type: input + id: submitting_author + attributes: + label: Submitting Author + placeholder: "@github_handle" + validations: + required: true + + - type: input + id: maintainers + attributes: + label: All current maintainers + placeholder: "@github_handle1, @github_handle2" + validations: + required: true + + - type: input + id: package_name + attributes: + label: Package Name + placeholder: my-package + validations: + required: true + + - type: input + id: one_line_description + attributes: + label: One-Line Description of Package + placeholder: Briefly describe what the package does + validations: + required: true + + - type: input + id: repository_link + attributes: + label: Repository Link + placeholder: https://github.com/owner/repo + description: Public GitHub repository URL used by automated triage. + validations: + required: true + + - type: input + id: version_submitted + attributes: + label: Version submitted + placeholder: v0.1.0 + description: Tag, branch, or commit to review. + validations: + required: true + + - type: textarea + id: editorial_tracking + attributes: + label: Editorial tracking + description: Leave these values as-is. Editors will update them during review. + value: | + EiC: TBD + Editor: TBD + Reviewer 1: TBD + Reviewer 2: TBD + Archive: TBD + JOSS DOI: TBD + Version accepted: TBD + Date accepted (month/day/year): TBD + validations: + required: true + + - type: checkboxes + id: conduct_and_maintenance + attributes: + label: Code of Conduct and commitment to maintain package + options: + - label: I agree to abide by pyOpenSci's Code of Conduct during the review process and in future interactions in spaces supported by pyOpenSci should it be accepted. + required: true + - label: I have read and will commit to package maintenance after the review as per the pyOpenSci Policies Guidelines. + required: true + + - type: textarea + id: description + attributes: + label: Description + description: Include a brief paragraph describing what your package does. + placeholder: Describe the package and its main purpose. + validations: + required: true + + - type: markdown + attributes: + value: | + ## Scope + + Check all relevant categories. If you are unsure whether your package is in scope, consider opening a pre-submission inquiry first. + + - type: checkboxes + id: scope + attributes: + label: Scope + options: + - label: Data retrieval + - label: Data extraction + - label: Data processing/munging + - label: Data deposition + - label: Data validation and testing + - label: Data visualization + - label: Workflow automation + - label: Citation management and bibliometrics + - label: Scientific software wrappers + - label: Database interoperability + + - type: checkboxes + id: domain_specific + attributes: + label: Domain specific + options: + - label: Geospatial + - label: Education + + - type: checkboxes + id: community_partnerships + attributes: + label: Community partnerships + options: + - label: Astropy - My package adheres to Astropy community standards + - label: Pangeo - My package adheres to the Pangeo standards listed in the pyOpenSci peer review guidebook + + - type: textarea + id: scope_explanation + attributes: + label: Scope explanation + description: Briefly explain how the package fits the selected categories. + placeholder: | + Who is the target audience and what are the scientific applications of this package? + + Are there other Python packages that accomplish the same thing? If so, how does yours differ? + + If you made a pre-submission enquiry, please paste the link to the corresponding issue, forum post, or other discussion, or @tag the editor you contacted. + validations: + required: true + + - type: checkboxes + id: technical_checks + attributes: + label: Technical checks + description: Confirm each of the following. + options: + - label: This package does not violate the Terms of Service of any service it interacts with. + - label: This package uses an OSI approved license. + - label: This package contains a README with instructions for installing the development version. + - label: This package includes documentation with examples for all functions. + - label: This package contains a tutorial with examples of its essential functions and uses. + - label: This package has a test suite. + - label: This package has continuous integration setup, such as GitHub Actions, CircleCI, or others. + + - type: checkboxes + id: publication_options + attributes: + label: Publication options + options: + - label: I wish to automatically submit to the Journal of Open Source Software. + + - type: checkboxes + id: joss_checks + attributes: + label: JOSS checks + description: Complete these only if you want automatic JOSS submission. + options: + - label: The package has an obvious research application according to JOSS's submission requirements. + - label: The package is not a minor utility as defined by JOSS's submission requirements. + - label: The package contains a `paper.md` matching JOSS's requirements by the time it is submitted to JOSS. + + - type: input + id: joss_doi + attributes: + label: Long-term repository DOI for JOSS + placeholder: 10.5281/zenodo.xxxxxxx + description: Optional unless you plan to use JOSS submission. + validations: + required: false + + - type: checkboxes + id: reviewer_prs + attributes: + label: Reviewer issues and pull requests + options: + - label: Yes, I am OK with reviewers submitting requested changes as issues or pull requests to my repository. + required: true + + - type: checkboxes + id: author_commitments + attributes: + label: Author commitments + options: + - label: I have read the author guide. + required: true + - label: I expect to maintain this package for at least 2 years and can help find a replacement maintainer if needed. + required: true + - label: I filled out the pre-review survey. + required: true + + - type: markdown + attributes: + value: | + ## References + + - Packaging guide: https://www.pyopensci.org/python-package-guide/ + - Package scope: https://www.pyopensci.org/software-peer-review/about/package-scope.html + - JOSS submission requirements: https://joss.readthedocs.io/en/latest/submitting.html#submission-requirements + - JOSS paper requirements: https://joss.readthedocs.io/en/latest/submitting.html#what-should-my-paper-contain + - Code of Conduct: https://www.pyopensci.org/handbook/CODE_OF_CONDUCT.html + - Author guide: https://www.pyopensci.org/software-peer-review/how-to/author-guide.html + - Editor template: https://www.pyopensci.org/software-peer-review/appendices/templates.html#editor-s-template + - Review template: https://www.pyopensci.org/software-peer-review/appendices/templates.html#peer-review-template + - Discussions: https://github.com/orgs/pyOpenSci/discussions + - Policies and maintenance commitment: https://www.pyopensci.org/software-peer-review/our-process/policies.html#after-acceptance-package-ownership-and-maintenance diff --git a/.github/workflows/pycmdcheck-triage.yml b/.github/workflows/pycmdcheck-triage.yml index cb024f1..c7b1d66 100644 --- a/.github/workflows/pycmdcheck-triage.yml +++ b/.github/workflows/pycmdcheck-triage.yml @@ -42,8 +42,28 @@ jobs: function getField(label) { const escaped = label.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); - const match = body.match(new RegExp(`^${escaped}:\\s*(.+)$`, 'mi')); - return match ? match[1].trim() : ''; + const legacyMatch = body.match(new RegExp(`^${escaped}:\\s*(.+)$`, 'mi')); + if (legacyMatch) { + const value = legacyMatch[1].trim(); + return value === '_No response_' ? '' : value; + } + + const headingMatch = body.match( + new RegExp(`^###\\s+${escaped}\\s*$([\\s\\S]*?)(?=^###\\s+|\\Z)`, 'mi') + ); + + if (!headingMatch) { + return ''; + } + + const value = headingMatch[1] + .split('\n') + .map((line) => line.trim()) + .filter((line) => line && !line.startsWith('