encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-07-23 06:29:58 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update docs/topics/contributing.md

Browse Source
This commit is contained in:
Rob Romano 2012-11-19 19:11:35 -08:00
parent f5f1ac49ec
commit f213299d7f
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/topics/contributing.md
View File

@ -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