You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _pages/how-to-submit.md
+9-13Lines changed: 9 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,10 +18,9 @@ toc: true
18
18
19
19
You’ve created a Python package—now what? How do you ensure it follows best practices, is well-documented, and reaches the right audience?
20
20
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.
22
22
23
-
24
-
### <iclass="fa-solid fa-circle-chevron-down"></i> Why submit a Python package for software peer review?
23
+
### <iclass="fa-solid fa-circle-chevron-down"></i> Why submit a Python package for review?
25
24
- <iclass="fa-solid fa-eye"style="color:#8B868E"></i> **Visibility & support:** Gain expert feedback on your code, documentation, and packaging.
26
25
- <iclass="fa-solid fa-check-circle"style="color:#8B868E"></i> **Quality & best practices:** Ensure your package follows open-source and scientific standards.
27
26
- <iclass="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
50
49
51
50
## <iclass="fa-solid fa-list-check"style="color:#81c0aa;"></i> Step-by-step guide to submitting your package for review
52
51
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:
55
53
56
54
-**Package structure & quality:** Ensure best practices in documentation, testing, and maintenance.
57
55
-**Usability & reproducibility:** Improve user experience and scientific reliability.
58
56
-**Visibility:** Join a vetted ecosystem of high-quality, community-endorsed Python tools.
59
57
60
58
Follow the steps below to submit your package for review.
61
59
60
+
**[<iclass="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
+
62
63
### <iclass="fa-solid fa-magnifying-glass"style="color:#a193c6"></i> 1. Check if your package is in pyOpenSci's scope
63
64
64
65
Before submitting, ensure your package fits within [**pyOpenSci’s peer review scope**](https://www.pyopensci.org/software-peer-review/about/package-scope.html).
65
66
66
-
Your package is a good fit if:
67
+
Your package is a good fit if it:
67
68
68
69
-**Supports a scientific application:** Examples include data retrieval, processing, and visualization.
-**Does not significantly overlap:** Your package should provide new functionality rather than duplicate an existing package in the ecosystem.
71
72
72
-
73
73
#### <iclass="fa-solid fa-circle-question"style="color:#81c0aa;"></i> Unsure if your package is in scope?
74
74
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.
76
76
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.)*
79
77
80
-
## TODO: move this somewhere better.
81
-
📖 Read the Author Guide – A detailed walkthrough of the review process
82
78
83
79
### <iclass="fa-solid fa-tools"style="color:#a193c6"></i> 2. Check if your package meets our pre-review requirements
84
80
@@ -132,7 +128,7 @@ Once submitted, our editors will review your issue and guide you through the nex
132
128
Our peer review workflow relies on scripts to process submission data. If the template structure is modified, it will break our automated processes!
133
129
</div>
134
130
135
-
### <iclass="fa-solid fa-list-check"style="color:#81c0aa;"></i> Choose the correct submission type
131
+
### <aid="submission-type"></a> <iclass="fa-solid fa-list-check"style="color:#81c0aa;"></i> Choose the correct submission type
136
132
137
133
There are **three submission types** that you can select from:
0 commit comments