Don’t be afraid to commit¶
A workshop/tutorial 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.
The workshop will take participants through the complete cycle of identifying a simple issue in a Django or Python project, writing a patch with tests and documentation, and submitting it.
The purpose of the workshop¶
Don’t be afraid to commit will help put you in a position to commit successfully to collaborative projects.
You’ll find it particularly useful if you think you have some good coding ideas, but find that managing the development process sometimes gets in the way of your actual development.
virtualenv and pip will help you manage your own work in a more streamlined and efficient way.
Git and GitHub will also help you manage your own workflow and development, and will make it possible for you to collaborate effectively with others. The Django Project, like many other open projects, uses both.
Automated tests will help you develop your software faster, better and more easily and give other developers more confidence in your contributions.
Documentation - being able to create, manage and publish documentation in an efficient and orderly way will make your work more accessible and more interesting to other people.
Contributing - how to submit your work
- What you need to know and have installed before you begin
- Virtualenv and pip
- Git and GitHub
- Automated testing in Python and Django
- Documentation using Sphinx and ReadTheDocs.org
- Contributing your work
- Cheatsheet - a handy summary of key commands and techniques
- A record of people who attended a workshop or followed the tutorial
- Notes for anyone planning a workshop
“Don’t be afraid to commit” was created by Daniele Procida. Other contributors include:
- Daniel Quinn
- Brian Crain (@crainbf)
- Paul Grau
- Nimesh Ghelani https://github.com/nims11
- Robert Dragan https://github.com/rmdragan
- David Garcia https://github.com/davideire
- Jason Blum https://github.com/jasonblum
Many thanks are also due to the members of #django, #python, #git and #github on irc.freenode.net for their endless online help.
... and if I have neglected to mention someone, please let me know.
Please feel free to use and adapt the tutorial.