Robert Sparks edited this page
Mar 15, 2022
Clone this wiki locally
This page contains notes on how to run a successful IETF Code Sprint.
If you are a Code Sprint participant, please see SprintCoderSetup for information on environment setup and workflow.
- Create a Code Sprint description page (e.g., IETF105Sprint) that gives an overview of what's planned for the sprint.
- Create a Code Sprint Signup page (e.g., IETF105SprintSignUp that lets people sign up for the sprint and also provides participant commitment and advance info for the sprint organizers.
- Write Setup Information (e.g., SprintCoderSetup, SprintDatabase) that lets the participants set up their environment ahead of time or at the sprint start.
- Announce the sprint on the IETF mailing list and announcement list (normally done by the IETF Chair).
- Make sure that room and food planning is done (normally done by the Secretariat).
- Just before the start of the sprint, when the signup page can be expected to be reasonably complete, use the information from that to create an individual SVN branch for each sprint participant. The mksprintbranch script can be used to facilitate this.
- As people pick tasks, have them update the code sprint plan (e.g., the IETF 105 Sprint Plan) with their tasks.
- As people complete tasks to the point where the code is ready to be merged, have them update the completed code table in the sprint description with the relevant information (as in the IETF 105 Sprint Completed Code).
- As soon as some code is ready to merge, do a brief code review, do the merge, and note the relevant information in the completed code table. Release all merged code during the day.
- The signup page and the completed code table is used by the IETF Chair to acknowledge the people who participated and contributed during the plenary.