openstack/training-guides
Code Issues Proposed changes
b800f3a6bb
training-guides/doc/upstream-training/upstream-details.rst
Andreas Jaeger 9a06a6a01c Use git.openstack.org everywhere 
Our official git master is at git.openstack.org, update places
that use github instead.

Also fixes link to DefCore document, the document has moved.

Change-Id: Iac65643aa2566df2a24732f7b1c6d6093d8092f2
2015-12-29 19:44:57 +01:00

13 KiB
Raw Blame History

OpenStack Upstream Training Details

Introduction

With over 2000 developers from 80 different companies worldwide, OpenStack is one of the largest collaborative software-development projects. Because of its size, it is characterized by a huge diversity in social norms and technical conventions. These can significantly slow down the speed at which newcomers are successful at integrating their own roadmap into that of the OpenStack project.

We've designed a training program to help professional developers negotiate this hurdle. It shows them how to ensure their bug fix or feature is accepted in the OpenStack project in a minimum amount of time. The educational program requires students to work on real-life bug fixes or new features during two days of real-life classes and online mentoring, until the work is accepted by OpenStack. The live two-day class teaches them to navigate the intricacies of the project's technical tools and social interactions. In a followup session, the students benefit from individual online sessions to help them resolve any remaining problems they might have.

Objectives

  • Faster integration of the companies product roadmap into the OpenStack release cycle
  • Successfully contribute one real world patch to an OpenStack component
  • Master the technical tools
  • Understand the OpenStack contribution workflow and social norms

Target Audience

  • Developers
  • System administrators

Prerequisites

  • Being able to read and write English at a technical level.
  • If contributing code, being technically proficient enough to carry out simple bug fixes in the project.
  • If contributing documentation, being able to produce documents in the project's chosen infrastructure.
  • Having at least 8 hours a week to dedicate to the project, be it through programming or through interacting with the community.

Duration

  • Face-to-face section: 2 days
  • Online section: 10 one-hour individual mentoring sessions over a period of 4 to 10 weeks

Infrastructure

Course Outline

First day

Introduction

  • A week before Day 1: choice of a contribution, via email, with each participant
  • Day 1: How OpenStack is made
  • Day 1: Learn and practice git, gerrit, IRC
  • Day 2: The theory of contribution
  • Day 2: Lego contribution simulation
  • Day 2: Individual presentation of the contribution plan
  • Day 2: Online mentoring

How OpenStack is made (3h including 1h30 exercises)

Workflow of an OpenStack contribution and tools (3h including 2h exercises)

Second day

The Contribution Process (1 hour)

Overview of the contribution process (slides)

  • Take the pulse of the project.
  • Figure out who's behind it.
  • Determine the project's social groups.
  • Assess your approach.
  • Engage immediately.
  • Play with your network.
  • Perform the smaller tasks.
  • Choose a question.
  • Familiarize yourself with the code of conduct.
  • Understand the conventions.
  • Explain what you do.
  • Prepare the backport.
  • Learn what's local and what's upstream.
  • Learn what distinguishes good work flow from bad work flow.
  • Quantify the delta.
  • Speed up the acceptance.
  • Determine the time frame.
  • Maximize karma.
  • Work in parallel.
  • Archive and collect.

Agile for Contributors (15 min)

Lego applied to Free Software contributions (slides)

  • Apply agile
  • Who is the customer?
  • Company & Upstream product owner
  • Sprint review presentation to Upstream

Contribution Simulation (2 hour)

The students make a virtual contribution simulation using Lego bricks as props, with the goal of expanding a Lego town, built by upstream. They are divided into teams; the teacher is by turns the product owner in the company and the upstream.

Contribution Planning (2 hours)

ODP slides PDF slides

  • The students use template slides to prepare a 5-minute presentation of their planned contribution.
  • A sample presentation is given by the teacher, as an example.
  • Each student group prepares a presentation describing:
    • the contribution they plan to work on during the online sessions,
    • how they will engage with the Upstream,
    • how it contributes to the company's agenda
    • and whom they will be working with.
  • Each student group presents its slides to the class

Etherpad

https://etherpad.openstack.org/p/upstream-training-vancouver

Complete index in slide format only