search

python / devguide

The Python developer's guide
https://devguide.python.org/
Creative Commons Zero v1.0 Universal
1.86k stars 779 forks source link

Add a Sprints organization/preparation section to devguide #7

Open brettcannon opened 8 years ago

brettcannon commented 8 years ago

Originally from http://bugs.python.org/issue24016

matrixise commented 8 years ago

@willingc I have started a new section with your comment from https://bugs.python.org/issue24016

I have organised a sprint on 13rd and 14th october and I would like your feedback and maybe improve the text. https://github.com/matrixise/devguide/blob/add-sprint-section/sprints.rst

I can give you the access rights on this repo if you think you can help me.

matrixise commented 8 years ago

I think we can add @bitdancer in the loop, because he has organised the sprints during PyCon US.

willingc commented 8 years ago

Hi @matrixise,

Great start. :sunny: Feel free to open a WIP PR and I can comment (just one or two wording things) or access to your fork. The first may be simpler since it keeps all the discussion in one place.

Overall, I would call this a checklist (similar in spirit to what we created for OpenHatch https://github.com/openhatch/in-person-event-handbook/blob/master/checklists.pdf). OpenHatch's Open Source Event Handbook: http://opensource-events.com is another good resource.

Add to checklist under "during the event":

Suggest creating a static site that provides the sprint details:

Perhaps creating a cookiecutter that takes the sprint details and autopopulates the static site would be a good first contributor project. (cc/ @Mariatta)

matrixise commented 8 years ago

@willingc you have received the access rights for my repo, I would be really happy if you want to contribute to this part.

willingc commented 8 years ago

Thanks @matrixise. Will do later this weekend. I'm actually helping run a hackathon today at a local university.

matrixise commented 8 years ago

I am going to work on this part during this week-end. @willingc, did you have the opportunity to work/think about this section ?

Mariatta commented 8 years ago

@matrixise @willingc Perhaps once you have the checklist ready, I can work on creating the cookie cutter project based on it. Thanks 😃

matrixise commented 8 years ago

@Mariatta with pleasure, and of course, I can help you once you have a small proto.

willingc commented 8 years ago

@matrixise @Mariatta I was at Grace Hopper all last week. I'm going to catch up today after traveling, and then full steam ahead.

Mariatta commented 7 years ago

Maybe this can be closed in favor of https://github.com/python/devinabox/issues/12 ?

ncoghlan commented 7 years ago

Even if the details are delegated to the devinabox documentation, it would still make sense to have section about it in the developer guide.

However, that section could be smaller, perhaps just a subparagraph in "Communications" that primarily covers effective sprint participation (and expectation setting), and then points to the devinabox documentation for guidance on running a CPython focused sprint.

brettcannon commented 7 years ago

I'm also fine with simply closing devinabox and moving the relevant documentation here. It started out as a separate repo because there were more helper scripts in the past, but they have slowly been pared down and so it's basically just a big README now. 😄

willingc commented 7 years ago

@brettcannon How would you feel about using devinabox repo to contain docs that could be used by a sprint organizer to create a static site (from their fork) that could be customized for the same event?

We did something similar for OpenHatch's Open Source Comes to Campus events as does Django Girls. Here's a rough repo that we used each year for Grace Hopper's Open Source Day (https://github.com/willingc/ghc-openhatch-2016) and a spartan static site (https://willingc.github.io/ghc-openhatch-2016/welcome/).

brettcannon commented 7 years ago

@willingc SGTM

ncoghlan commented 7 years ago

Software Carpentry also use that "Copy-and-customise" model for their bootcamps, so setting up something similar for CPython sprints sounds sensible to me.

It also provides a separate issue tracker for folks to ask questions specifically about running a CPython sprint, rather than about contributing to CPython in general.