Introduction
============

There are two major components to this model: a canonical repository
and repositories for each individual workshop. The canonical
repository serves several purposes: one, it is an incarnation of the
phrase, "the code is the documentation" and addresses the question,
"What is Software Carpentry?" If someone looks at the canonical
repository they will get a sense of the scope and depth of the SWC
project. Second, the canonical repo gives new instructors a starting
seed so they don't have to generate their lesson material from
scratch. The canonical repository will mostly be viewed by people
arriving from the web and will mostly be consumed by individuals
working alone. As such, the material in it should be constructed to
best serve those users. The individual workshop repos exist to
minimize the operational overhead of workshop instructors and to draw
a sharp logical boundary between different types of material that is
pitched at distinct audiences. Material in any workshop repo should be
constructed to best serve students attending that specific workshop.

Filesystem Structure
====================

The canonical repo and the workshop repos will have the same general
filesystem structure. Different modules will be organized into
different folders. For example, there may be a folder with material on
"python testing" or on "remote repos with git." The specific format of
the material in any of these folders as well as auxiliary files
(images, ipython notebooks, data) are decisions left up to the
developers/workshop instructors.

Canonical Repo Development Workflow
===================================

The development model of the canonical repository will be the typical
DVCS github model: a contributor forks the repo into their own github
account, makes changes, then issues a pull request. SWC maintainers
look at the changes and merge them into the main repo when
appropriate.

Workshop Repos Development Workflow
===================================

The development workflow for a workshop is as follows: one of the
workshop instructors creates a new repository under the swcarpentry
github organization with a uniform name (YYYY-MM-location). The
repository is populated with material via copy-and-paste or by setting
up a remote and merging in content from, say, a previous
workshop. Material in the repository is developed by instructors
commiting and pushing directly to the repository without the fork/pull
request like in the canonical repo. In the unlikely event that
workshop material needs to be merged back into the canonical
repository, the maintainers of the canonical repo set up a remote to
the workshop repo and merge in the changes.