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
+78-47Lines changed: 78 additions & 47 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,17 +14,17 @@ toc: true
14
14
15
15
16
16
17
-
## <iclass="fa-solid fa-rocket"style="color:#a193c6"></i> Submit Your Python Package for pyOpenSci Review
17
+
## <iclass="fa-solid fa-rocket"style="color:#a193c6"></i> Submit your Python package for review
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
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).
22
22
23
23
24
-
### <iclass="fa-solid fa-circle-chevron-down"style="color:#a193c6"></i> Why submit a Python package for software peer review?
25
-
- <iclass="fa-solid fa-eye"style="color:#81c0aa;"></i> **Visibility & support:** Gain expert feedback on your code, documentation, and packaging.
26
-
- <iclass="fa-solid fa-check-circle"style="color:#81c0aa;"></i> **Quality & best practices:** Ensure your package follows open-source and scientific standards.
27
-
- <iclass="fa-solid fa-book-open"style="color:#81c0aa;"></i> **JOSS publication:** Get the option to publish in the Journal of Open Source Software (JOSS) after acceptance.
24
+
### <iclass="fa-solid fa-circle-chevron-down"></i> Why submit a Python package for software peer review?
25
+
- <iclass="fa-solid fa-eye"style="color:#8B868E"></i> **Visibility & support:** Gain expert feedback on your code, documentation, and packaging.
26
+
- <iclass="fa-solid fa-check-circle"style="color:#8B868E"></i> **Quality & best practices:** Ensure your package follows open-source and scientific standards.
27
+
- <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.
28
28
29
29
<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)**
30
30
@@ -117,8 +117,20 @@ Once your have determined that you package it in scope and meets our core packag
117
117
More....
118
118
</figcaption>
119
119
</figure>
120
+
120
121
Once submitted, our editors will review your issue and guide you through the next steps.
121
122
123
+
### <iclass="fa-solid fa-check"style="color:#81c0aa;"></i> Guidelines for filling out the issue template
124
+
125
+
***Complete all sections of the template.** If you have questions about fields, you can ask about them in the review issue.
126
+
***Do not modify existing formatting:** Please do not modify the template structure by adding elements to the template fields such as bold, italics, etc.
127
+
***Submit your issue only when fully completed:** If you can, try to avoid submitting an issue and then continuously editing it. If you'd like to work on the issue over time, consider forking our repository and working on the issue in your fork before submitting it as an option.
128
+
***If you made a pre-submission enquiry**, paste the link to the corresponding issue in your issue submission to link your submission request to the pre-submission discussion.
129
+
130
+
<divclass="notice notice--info"markdown="1">
131
+
<iclass="fa-solid fa-circle-exclamation"style="color:#81c0aa;"></i> **Why does filling out our review template matter?**
132
+
Our peer review workflow relies on scripts to process submission data. If the template structure is modified, it will break our automated processes!
133
+
</div>
122
134
123
135
### <iclass="fa-solid fa-list-check"style="color:#81c0aa;"></i> Choose the correct submission type
124
136
@@ -149,26 +161,13 @@ If you need help getting your package ready for review, you can submit a help re
149
161
150
162
</div>
151
163
152
-
### <iclass="fa-brands fa-github-alt"style="color:#81c0aa;"></i> Understanding our GitHub issue submission process
153
-
154
-
When you submit your package for review, you will **fill out a GitHub issue template**. This structured template helps our editorial board evaluate your package efficiently. This section helps you understand the elements of the template.
155
-
156
-
### <iclass="fa-solid fa-check"style="color:#81c0aa;"></i> Guidelines for filling out the issue template
157
-
158
-
***Complete all sections of the template.** If you have questions about fields, you can ask about them in the review issue.
159
-
***Do not modify existing formatting:** Please do not modify the template structure by adding elements to the template fields such as bold, italics, etc.
160
-
***Submit your issue only when fully completed:** If you can, try to avoid submitting an issue and then continuously editing it. If you'd like to work on the issue over time, consider forking our repository and working on the issue in your fork before submitting it as an option.
161
-
***If you made a pre-submission enquiry**, paste the link to the corresponding issue in your issue submission to link your submission request to the pre-submission discussion.
162
-
163
-
<divclass="notice notice--info"markdown="1">
164
-
<iclass="fa-solid fa-circle-exclamation"style="color:#81c0aa;"></i> **Why does filling out our review template matter?**
165
-
Our peer review workflow relies on scripts to process submission data. If the template structure is modified, it will break our automated processes!
166
-
</div>
164
+
## <iclass="fa-brands fa-github-alt"style="color:#81c0aa;"></i> About our GitHub issue submission process
167
165
166
+
The structured template of our GitHub issue helps our editorial board evaluate your package efficiently. This section will help you understand some of the core elements of our template.
168
167
169
168
### <iclass="fa-solid fa-eye-slash"style="color:#81c0aa;"></i> Sections you can ignore
170
169
171
-
Some sections of the template are **for editors only** and should be left blank. These include:
170
+
Some template sections are **for editors only** and should be left blank. These include:
One of the benefits of submitting your package to pyOpenSci for review is that once it's approved, it can be fast-tracked for publication with [JOSS](https://joss.theoj.org/). JOSS accepts pyOpenSci's review as theirs, and therefore, you will not need to go through another full review. Instead, JOSS will only review your paper.md file.
190
+
188
191
### <i class="fa-solid fa-users" style="color:#81c0aa;"></i> Community partnerships
189
192
190
-
We collaborate with domain-specific organizations to ensure high-quality reviews. If you are interested in becoming an affiliated project associated with one of our partners, you can click on the partner that your package's scope aligns with. Our most active partnership is with [Astropy](https://www.pyopensci.org/software-peer-review/partners/astropy.html).
191
193
192
-
If your package fits within one of our partnerships, we will assign an editor who is able to review your package for both OpenSci requirements and the affiliation project affiliation.
194
+
We collaborate with [domain-specific organizations](https://www.pyopensci.org/software-peer-review/partners/scientific-communities.html) that run their own package review processes. Instead of undergoing **separate reviews**, you package can be considered for affiliation with three organizations in **one streamlined pyOpenSci review**.
195
+
196
+
If your package fits within a partnered domain, we will assign an editor familiar with both **pyOpenSci’s** and the affiliated community’s **review standards**.
197
+
This allows your package to:
198
+
199
+
- **Gain community affiliation** (for example, Astropy for astronomy-related packages).
200
+
- **Join pyOpenSci’s vetted ecosystem** as a recognized open source tool.
201
+
- **Optionally be fast-tracked for publication in JOSS** after pyOpenSci acceptance.
202
+
203
+
**[Astropy](https://www.pyopensci.org/software-peer-review/partners/astropy.html)** is currently our most active partnership.
204
+
205
+
*Below is the template if you want to be considered for partner-community affiliation.*
206
+
207
+
```markdown
208
+
209
+
## Community Partnerships
210
+
211
+
If your package is associated with an existing community please check below:
212
+
213
+
- [ ] Astropy:[My package adheres to Astropy community standards](https://www.pyopensci.org/software-peer-review/partners/astropy.html)
214
+
- [ ] Pangeo: My package adheres to the [Pangeo standards listed in the pyOpenSci peer review guidebook][PangeoCollaboration]
@@ -200,44 +223,50 @@ If your package fits within one of our partnerships, we will assign an editor wh
200
223
</figcaption>
201
224
</figure>
202
225
203
-
### <i class="fa-solid fa-pen-to-square" style="color:#81c0aa;"></i> Double check your your submission before hitting submit
204
226
205
-
Before submitting your issue, double-check that all fields are filled out correctly. You can use the GitHub preview tab to ensure the issue looks correct. Check the following things:
227
+
### Code of conduct & package maintenance commitment
206
228
207
-
✅ The issue is **fully completed**
208
-
✅ The template **formatting has not been changed**
209
-
✅ The **Write tab preview looks correct**
229
+
To be considered for review, you must agree to both:
230
+
1. **Follow our Code of Conduct:** Ensure respectful and constructive collaboration.
231
+
2. **Commit to package maintenance:** Keep your package updated after acceptance.
210
232
211
-
## TODO: add screenshot of the preview
212
233
213
-
<div class="notice notice--tip" markdown="1">
214
-
One of the quirky things about the pyOpenSci submission template is that checkboxes have two completion methods:
215
-
- You can manually add an "X" inside the box (`[X]`).
216
-
- Or, after submission, click the box to check it off.
217
-
</div>
234
+
```markdown
235
+
## Code of Conduct & Commitment to Maintain Package
218
236
219
-
Need more Markdown help? Check out this [Markdown Guide](https://www.markdownguide.org/basic-syntax/).
237
+
- [ ] I agree to abide by [pyOpenSci's Code of Conduct][PyOpenSciCodeOfConduct] during the review process and in maintaining my package after should it be accepted.
238
+
- [ ] I have read and will commit to package maintenance after the review as per the [pyOpenSci Policies Guidelines][Commitment].
239
+
```
220
240
241
+
#### <i class="fa-solid fa-comments" style="color:#81c0aa;"></i> Code of conduct: constructive collaboration
221
242
222
-
Once you're ready, **submit your issue**, and our editors will take it from there! 🚀
243
+
pyOpenSci’s peer review is a **collaborative process** focused on **improving your package**.
244
+
We require all maintainers, reviewers, and editors to follow our [Code of Conduct](https://www.pyopensci.org/handbook/CODE_OF_CONDUCT.html) to ensure discussions remain **professional, constructive, and respectful**.
223
245
224
-
#### Code of Conduct & Commitment to Maintain Package
225
246
226
-
In order for your package to progress through the pyOpenSci review process, you'll need to check both of the [Code of Conduct](https://www.pyopensci.org/handbook/CODE_OF_CONDUCT.html) agreement as well as the [maintenance agreement](https://www.pyopensci.org/software-peer-review/our-process/policies.html#after-acceptance-package-ownership-and-maintenance) outlined in the [pyOpenSci Policies Guidelines](https://www.pyopensci.org/software-peer-review/about/intro.html). You can indicate your agreement in one of two ways:
Our peer review process aims to build a **trusted ecosystem of well-maintained scientific Python packages**. Maintainers should expect to **actively maintain** their package for at least **2 years** after acceptance.
250
+
251
+
If your primary goal is publication rather than ongoing package maintenance, consider submitting directly to [JOSS](https://joss.theoj.org/) instead.
252
+
253
+
<!--
254
+
You can indicate your agreement in one of two ways:
227
255
* adding an "X" (without quotation marks) inside the brackets in the Markdown version of the issue, so that it reads like this: [X]
228
256
* submitting the issue without making any changes to this section, and then clicking on the checkboxes when they're rendered in the submitted issue.
257
+
-->
229
258
230
-
<!-- #### For all submissions
259
+
## TODO: add screenshot of the preview
231
260
232
-
This section is important, as it helps us more holistically evaluate your package and determine whether or not it's a good fit for pyOpenSci review. Each of the following sections should be addressed/answered:
233
-
* *Explain how and why the package falls under the categories you indicated above.* Here's where you'll provide us with information that connects your package and its functionality to both its domain and technical capabilities.
234
-
* *Who is the target audience and what are scientific applications of this package?* This helps us understand who will be using the package.
235
-
* *Are there other Python packages that accomplish the same thing? If so, how does yours differ?* This helps us get a handle on other packages that fall within the same domain, as well as ensure that efforts aren't being duplicated.
236
-
-->
261
+
<div class="notice notice--tip" markdown="1">
262
+
One of the quirky things about the pyOpenSci submission template is that checkboxes have two completion methods:
263
+
- You can manually add an "X" inside the box (`[X]`).
264
+
- Or, after submission, click the box to check it off.
237
265
238
-
#### Publication Options
266
+
Need more Markdown help? Check out this [Markdown Guide](https://www.markdownguide.org/basic-syntax/).
267
+
</div>
239
268
240
-
One of the benefits of submitting your package to pyOpenSci for review is that once it's approved, it can be fast-tracked for publication with [JOSS](https://joss.theoj.org/). JOSS accepts pyOpenSci's review as theirs, and therefore you will not need to go through another full review. Instead, JOSS will only review your paper.md file.
269
+
Once you're ready, **submit your issue**, and our editors will take it from there! 🚀
241
270
242
271
#### Please fill out our survey
243
272
@@ -258,10 +287,12 @@ During this process, editors may request **minor updates** to help your package
258
287
259
288
📖 **Read the full review process in our** [Peer Review Guide](https://www.pyopensci.org/software-peer-review/how-to/author-guide.html).
260
289
290
+
<div class="notice notice--info" markdown="1">
261
291
## <i class="fa-regular fa-comments"></i> Connect with us!
262
292
263
-
If you found this how-to guide useful, or if you have suggestions for how to improve it, we'd love to hear from you! Reach out to us on:
293
+
If you found this how-to guide useful, or if you have suggestions for improving it, we'd love to hear from you! Reach out to us on:
0 commit comments