From f213299d7f9431a103fefa721fdfa05e885e7e96 Mon Sep 17 00:00:00 2001 From: Rob Romano Date: Mon, 19 Nov 2012 19:11:35 -0800 Subject: [PATCH] Update docs/topics/contributing.md --- docs/topics/contributing.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/topics/contributing.md b/docs/topics/contributing.md index 7fd61c10e..959abc818 100644 --- a/docs/topics/contributing.md +++ b/docs/topics/contributing.md @@ -4,8 +4,26 @@ > > — [Tim Berners-Lee][cite] +## Get the source + +Use `git` to clone the master REST Framework source files to your local systme. If you plan to contribute, +to the project, you also need to fork the repo on github. See https://help.github.com/articles/fork-a-repo +for more information. + ## Running the tests +Ensure your PYTHONPATH is configured so that the copy of REST Framework from your local git repo is picked up, +not any other version you may have installed on your system. + +Then, invoked the `runtests/runtests.py` script to execute all unittests. + +Here is an example session: + +``` +/home/mydir/djangorestframework$ export PYTHONPATH=/home/mydir/djangorestramework:$PYTHONPATH +/home/mydir/djangorestframework$ rest_framework/runtests/runtests.py +``` + ## Building the docs ## Managing compatibility issues