jose-reviews icon indicating copy to clipboard operation
jose-reviews copied to clipboard

[PRE REVIEW]: Teaching Python package development: A structured course with learning resources and an instructor's guide

Open editorialbot opened this issue 10 months ago • 13 comments

Submitting author: @geritwagner (Gerit Wagner) Repository: https://github.com/digital-work-lab/open-source-project Branch with paper.md (empty if default branch): jose Version: v0.2.0 Editor: Pending Reviewers: Pending Managing EiC: Lorena Barba

Status

status

Status badge code:

HTML: <a href="https://jose.theoj.org/papers/cc49b9604b9fd10bc8524d1539620be6"><img src="https://jose.theoj.org/papers/cc49b9604b9fd10bc8524d1539620be6/status.svg"></a>
Markdown: [![status](https://jose.theoj.org/papers/cc49b9604b9fd10bc8524d1539620be6/status.svg)](https://jose.theoj.org/papers/cc49b9604b9fd10bc8524d1539620be6)

Author instructions

Thanks for submitting your paper to JOSE @geritwagner. Currently, there isn't a JOSE editor assigned to your paper.

@geritwagner if you have any suggestions for potential reviewers then please mention them here in this thread (without tagging them with an @). You can search the list of people that have already agreed to review and may be suitable for this submission.

Editor instructions

The JOSE submission bot @editorialbot is here to help you find and assign reviewers and start the main review. To find out what @editorialbot can do for you type:

@editorialbot commands

editorialbot avatar Jan 30 '25 09:01 editorialbot

Hello human, I'm @editorialbot, a robot that can help you with some common editorial tasks.

For a list of things I can do to help you, just type:

@editorialbot commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@editorialbot generate pdf

editorialbot avatar Jan 30 '25 09:01 editorialbot

Software report:

github.com/AlDanial/cloc v 1.98  T=0.04 s (1749.1 files/s, 217205.1 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Markdown                        45           1834            369           3946
Text                             3              2              0           1013
XML                              1              0              0            685
TeX                              3             29             20            636
YAML                             9             51             15            380
Python                           2             50             40            127
make                             2             18              9             75
CSS                              1             19              5             58
SCSS                             1              7              0             41
SVG                              8              0              0              8
HTML                             1              1              0              0
-------------------------------------------------------------------------------
SUM:                            76           2011            458           6969
-------------------------------------------------------------------------------

Commit count by author:

   466	Gerit Wagner
    84	LaureenTh
    17	Links Fixer
    12	Carlo
     9	Laureen Thurner
     9	Stella1234-design
     7	dependabot[bot]
     3	github-actions[bot]

editorialbot avatar Jan 30 '25 09:01 editorialbot

Paper file info:

🚨 Wordcount for paper.md is 3647

✅ The paper includes a Statement of need section

editorialbot avatar Jan 30 '25 09:01 editorialbot

License info:

🟡 License found: Other (Check here for OSI approval)

editorialbot avatar Jan 30 '25 09:01 editorialbot

@editorialbot generate pdf

geritwagner avatar Jan 30 '25 10:01 geritwagner

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

editorialbot avatar Jan 30 '25 10:01 editorialbot

@editorialbot check repository

geritwagner avatar Jan 30 '25 10:01 geritwagner

Software report:

github.com/AlDanial/cloc v 1.98  T=0.04 s (1764.8 files/s, 215493.8 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Markdown                        45           1804            248           3939
Text                             3              2              0           1013
XML                              1              0              0            685
TeX                              3             29             20            636
YAML                             9             51             15            380
Python                           2             50             40            127
make                             2             18              9             75
CSS                              1             19              5             58
SCSS                             1              7              0             41
SVG                              8              0              0              8
HTML                             1              1              0              0
-------------------------------------------------------------------------------
SUM:                            76           1981            337           6962
-------------------------------------------------------------------------------

Commit count by author:

   468	Gerit Wagner
    84	LaureenTh
    17	Links Fixer
    12	Carlo
     9	Laureen Thurner
     9	Stella1234-design
     7	dependabot[bot]
     3	github-actions[bot]

editorialbot avatar Jan 30 '25 10:01 editorialbot

Paper file info:

🚨 Wordcount for paper.md is 2351

✅ The paper includes a Statement of need section

editorialbot avatar Jan 30 '25 10:01 editorialbot

License info:

🟡 License found: Other (Check here for OSI approval)

editorialbot avatar Jan 30 '25 10:01 editorialbot

Thank you for opening the pre-review issue. I just fixed the paper.md to ensure that the pdf is generated successfully and removed material in comments for a more adequate word count. I also included the standard Creative Commons (CC-BY) license.

geritwagner avatar Jan 30 '25 10:01 geritwagner

I have reviewed the list of potential reviewers and identified the following people as a strong fit:

  • mcburton
  • krother
  • gcdeshpande
  • mattforshaw
  • fbidu
  • lechten

geritwagner avatar Mar 14 '25 07:03 geritwagner

@NickleDave — would you be willing to help us out with a review of this submission to The Journal of Open Source Education, JOSE? We still need to assign a handling editor, but I thought of you for reviewing since you did such a wonderful job of presenting about Python packaging at last year's URSSI Summer School at GW.

Might you also suggest a couple of other people to review? (We need two to proceed.)

labarba avatar Apr 29 '25 21:04 labarba

Hi @labarba I'm happy to review.

I see the intro references pyOpenSci and py-pkgs.org -- I wonder if @lwasser @tomasbeuzen @ttimbers have ideas for potential reviewers (apologies for tagging you in, I know y'all are busy folks)

NickleDave avatar Apr 30 '25 16:04 NickleDave

@editorialbot invite @ttimbers as editor

labarba avatar May 01 '25 13:05 labarba

Invitation to edit this submission sent!

editorialbot avatar May 01 '25 13:05 editorialbot

👋 @ashleefv – could you take this JOSE submission as editor? (Teaching Python package development: A structured course with learning resources and an instructor's guide) We already have one agreed reviewer, and perhaps a second reviewer could be one of the authors of this other JOSE paper: https://jose.theoj.org/papers/10.21105/jose.00130

labarba avatar Jun 17 '25 21:06 labarba

@labarba Yes, I can edit this.

ashleefv avatar Jun 18 '25 14:06 ashleefv

@editorialbot invite @ashleefv as editor

ashleefv avatar Jun 18 '25 14:06 ashleefv

I'm sorry @ashleefv, I'm afraid I can't do that. That's something only eics are allowed to do.

editorialbot avatar Jun 18 '25 14:06 editorialbot

@editorialbot assign @ashleefv as editor

labarba avatar Jun 18 '25 15:06 labarba

Assigned! @ashleefv is now the editor

editorialbot avatar Jun 18 '25 15:06 editorialbot

@editorialbot commands

ashleefv avatar Jun 18 '25 15:06 ashleefv

Hello @ashleefv, here are the things you can ask me to do:


# List all available commands
@editorialbot commands

# Add to this issue's reviewers list
@editorialbot add @username as reviewer

# Remove from this issue's reviewers list
@editorialbot remove @username from reviewers

# Get a list of all editors's GitHub handles
@editorialbot list editors

# Assign a user as the editor of this submission
@editorialbot assign @username as editor

# Remove the editor assigned to this submission
@editorialbot remove editor

# Remind an author, a reviewer or the editor to return to a review after a 
# certain period of time (supported units days and weeks)
@editorialbot remind @reviewer in 2 weeks

# Adds a checklist for the reviewer using this command
@editorialbot generate my checklist

# Set a value for version
@editorialbot set v1.0.0 as version

# Set a value for branch
@editorialbot set jose-paper as branch

# Set a value for repository
@editorialbot set https://github.com/organization/repo as repository

# Set a value for the archive DOI
@editorialbot set 10.5281/zenodo.6861996 as archive

# Mention the EiCs for the correct track
@editorialbot ping track-eic

# Run checks and provide information on the repository and the paper file
@editorialbot check repository

# Check the references of the paper for missing DOIs
@editorialbot check references

# Generates the pdf paper
@editorialbot generate pdf

# Recommends the submission for acceptance
@editorialbot recommend-accept

# Generates a LaTeX preprint file
@editorialbot generate preprint

# Flag submission with questionable scope
@editorialbot query scope

# Get a link to the complete list of reviewers
@editorialbot list reviewers

# Creates a post-review checklist with editor and authors tasks
@editorialbot create post-review checklist

# Open the review issue
@editorialbot start review

editorialbot avatar Jun 18 '25 15:06 editorialbot

@editorialbot add @NickleDave as reviewer

ashleefv avatar Jun 18 '25 15:06 ashleefv

@NickleDave added to the reviewers list!

editorialbot avatar Jun 18 '25 15:06 editorialbot

@marisalim Are you available to review this submission to The Journal of Open Source Education, JOSE? It seems related to your own previous publication: https://jose.theoj.org/papers/10.21105/jose.00130

ashleefv avatar Jun 18 '25 15:06 ashleefv

@ACharbonneau @abhijna @marisalim @s-canchi @ctb Are you available to review this submission to The Journal of Open Source Education, JOSE? It seems related to your own previous publication: https://jose.theoj.org/papers/10.21105/jose.00130

ashleefv avatar Jul 10 '25 14:07 ashleefv

I'm interested, but only available in 3 weeks (first week of August).

ctb avatar Jul 10 '25 14:07 ctb