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-package.md
+4-11Lines changed: 4 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,14 +14,9 @@ toc: true
14
14
15
15
## <iclass="fa-solid fa-rocket"style="color:#a193c6"></i> Submit your Python package for review
16
16
17
-
You’ve created a Python package—now what? How do you ensure it follows best practices, is well-documented, and reaches the right audience?
17
+
You’ve created a Python package! Yay! Now, how do you ensure it follows best practices and gets seen by the broader Python community?
18
18
19
-
**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.
20
-
21
-
### <iclass="fa-solid fa-circle-chevron-down"></i> Why submit a Python package for review?
22
-
- <iclass="fa-solid fa-eye"style="color:#8B868E"></i> **Visibility & support:** Gain expert feedback on your code, documentation, and packaging.
23
-
- <iclass="fa-solid fa-check-circle"style="color:#8B868E"></i> **Quality & best practices:** Ensure your package follows open-source and scientific standards.
24
-
- <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.
19
+
**pyOpenSci’s peer review process** connects you with community members who will review your package, help refine its structure, documentation, and usability. Accepted packages become part of our vetted ecosystem, increasing their visibility. 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.
25
20
26
21
<iclass="fa-solid fa-book"style="color:#81c0aa;"></i> **[Learn more about the benefits of our peer review process](https://www.pyopensci.org/software-peer-review/about/benefits.html)**
27
22
@@ -35,8 +30,6 @@ You’ve created a Python package—now what? How do you ensure it follows best
35
30
</figcaption>
36
31
</figure>
37
32
38
-
Read more about the benefits of pyOpenSci's open peer review process in our [Peer Review Guide](https://www.pyopensci.org/software-peer-review/about/benefits.html).
39
-
40
33
<divclass="notice"markdown="1">
41
34
42
35
#### <iclass="fa-solid fa-graduation-cap"></i> New to Python packaging?
@@ -51,8 +44,8 @@ If you're still working on your package and want guidance, check out our
51
44
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:
52
45
53
46
-**Package structure & quality:** Ensure best practices in documentation, testing, and maintenance.
54
-
-**Usability & reproducibility:** Improve user experience and scientific reliability.
55
-
-**Visibility:** Join a vetted ecosystem of high-quality, community-endorsed Python tools.
47
+
-**Usability:** Improve a users experience by adding clear documentation and quick start tutorials.
48
+
-**Visibility:** Join a vetted ecosystem of high-quality, community-endorsed Python tools that scientists can discover and trust.
56
49
57
50
Follow the steps below to submit your package for review.
0 commit comments