Don't be afraid to commit - a workshop/tutorial for inexperienced Python/Django developers who would like to contribute more to the projects they use.
License: BSD 2-Clause "Simplified" License
afraid-to-commit's Introduction
=========================
Don't be afraid to commit
=========================
A hands-on workshop for Python/Django developers who would like to contribute
more to the projects they use, but need more grounding in some of the tools
required.
What's in it for you
====================
As well as helping to put you in a position to commit successfully to
collaborative projects, the workshop's emphasis on using virtualenv/pip and
git will help you manage your own work in a more streamlined and efficient
way.
What we'll cover
================
The workshop will take participants through the complete cycle of identifying a simple issue in a
Django or Python project, writing a patch with documentation, and submitting it.
The workshop will take you through the use of:
* virtualenv and pip
* git (and GitHub)
* writing and building documentation using Sphinx
* submitting a pull request
A workbook and reference guide will be provided to support the workshop.
What you need to know
=====================
The workshop is open to anyone, but places will be limited.
In the section http://dont-be-afraid-to-commit.readthedocs.org/en/latest/git/commandlinegit.html#create-a-new-branch "Create a new branch", there is a note on an alternative method for creating a new branch based on the upstream master. At this stage in the tuturial, attempting to run that command will fail. Perhaps it could be made clear that the student won't be able to run the command at this point?
There is a step missing in the chapter "Documentation using Sphinx and ReadTheDocs.org". You must first open a new repository on Github, before you can push your "my-first-docs" repository up there. See paragraph "Add, commit and push".