Skip to content

Commit 58a60c5

Browse files
committed
more
1 parent 555c9f1 commit 58a60c5

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

_pages/how-to-submit.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,9 @@ toc: true
1818

1919
You’ve created a Python package—now what? How do you ensure it follows best practices, is well-documented, and reaches the right audience?
2020

21-
**pyOpenSci’s peer review process** connects you with experts who will help refine your package’s structure, documentation, and usability. Accepted packages become part of our vetted ecosystem, increasing their visibility and credibility. You may also have the opportunity to publish in the [Journal of Open Source Software (JOSS)](https://www.pyopensci.org/software-peer-review/partners/joss.html).
21+
**pyOpenSci’s peer review process** connects you with experts who will help refine your package’s structure, documentation, and usability. Accepted packages become part of our vetted ecosystem, increasing their visibility and credibility. And finally, if your package is in scope, you can also publish it in the [Journal of Open Source Software (JOSS)](https://www.pyopensci.org/software-peer-review/partners/joss.html) through our single end-to-end review process.
2222

23-
24-
### <i class="fa-solid fa-circle-chevron-down"></i> Why submit a Python package for software peer review?
23+
### <i class="fa-solid fa-circle-chevron-down"></i> Why submit a Python package for review?
2524
- <i class="fa-solid fa-eye" style="color:#8B868E"></i> **Visibility & support:** Gain expert feedback on your code, documentation, and packaging.
2625
- <i class="fa-solid fa-check-circle" style="color:#8B868E"></i> **Quality & best practices:** Ensure your package follows open-source and scientific standards.
2726
- <i class="fa-solid fa-book-open" style="color:#8B868E"></i> **JOSS publication:** Get the option to publish in the Journal of Open Source Software (JOSS) after acceptance.
@@ -50,35 +49,32 @@ Read more about the benefits of pyOpenSci's open peer review process in our [Pee
5049

5150
## <i class="fa-solid fa-list-check" style="color:#81c0aa;"></i> Step-by-step guide to submitting your package for review
5251

53-
Our **open peer review process** happens through GitHub issues in the
54-
[**pyOpenSci software submission repository**](https://github.com/pyopensci/software-submission). Using open GitHub issues ensures a **transparent and constructive** review process focused on improving:
52+
Our **open peer review process** happens through GitHub issues in the [**pyOpenSci software submission repository**](https://github.com/pyopensci/software-submission). Using open GitHub issues ensures a **transparent and constructive** review process focused on improving:
5553

5654
- **Package structure & quality:** Ensure best practices in documentation, testing, and maintenance.
5755
- **Usability & reproducibility:** Improve user experience and scientific reliability.
5856
- **Visibility:** Join a vetted ecosystem of high-quality, community-endorsed Python tools.
5957

6058
Follow the steps below to submit your package for review.
6159

60+
**[<i class="fa-solid fa-book"></i> Read our Author Guide for an overview of the process](https://www.pyopensci.org/software-peer-review/how-to/author-guide.html)**{: .btn .btn--primary}
61+
62+
6263
### <i class="fa-solid fa-magnifying-glass" style="color:#a193c6"></i> 1. Check if your package is in pyOpenSci's scope
6364

6465
Before submitting, ensure your package fits within [**pyOpenSci’s peer review scope**](https://www.pyopensci.org/software-peer-review/about/package-scope.html).
6566

66-
Your package is a good fit if:
67+
Your package is a good fit if it:
6768

6869
- **Supports a scientific application:** Examples include data retrieval, processing, and visualization.
6970
- **Meets packaging & maintenance expectations:** Installable, documented, tested, and actively maintained.
7071
- **Does not significantly overlap:** Your package should provide new functionality rather than duplicate an existing package in the ecosystem.
7172

72-
7373
#### <i class="fa-solid fa-circle-question" style="color:#81c0aa;"></i> Unsure if your package is in scope?
7474

75-
If you're unsure, **submit a pre-submission inquiry** to get feedback from our editorial team before starting the full review process.
75+
If you're unsure, [**🔗 submit a pre-submission inquiry**](#submission-type) to get feedback from our editorial team before starting the full review process.
7676

77-
🔗 **[Check how to submit a pre-submission inquiry](#3-submit-your-package-for-review-or-submit-a-presubmission-inquiry)**
78-
*(Jump to the next section for full details on submitting a pre-submission inquiry.)*
7977

80-
## TODO: move this somewhere better.
81-
📖 Read the Author Guide – A detailed walkthrough of the review process
8278

8379
### <i class="fa-solid fa-tools" style="color:#a193c6"></i> 2. Check if your package meets our pre-review requirements
8480

@@ -132,7 +128,7 @@ Once submitted, our editors will review your issue and guide you through the nex
132128
Our peer review workflow relies on scripts to process submission data. If the template structure is modified, it will break our automated processes!
133129
</div>
134130

135-
### <i class="fa-solid fa-list-check" style="color:#81c0aa;"></i> Choose the correct submission type
131+
### <a id="submission-type"></a> <i class="fa-solid fa-list-check" style="color:#81c0aa;"></i> Choose the correct submission type
136132

137133
There are **three submission types** that you can select from:
138134

0 commit comments

Comments
 (0)