#30816: Add or clarify documentation for contributing to Django (running Django
tests vs testing a Django project)
-----------------------------------------+------------------------
Reporter: Ad Timmering | Owner: nobody
Type: Uncategorized | Status: new
Component: Uncategorized | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-----------------------------------------+------------------------
(Adding a ticket based on [https://groups.google.com/forum/#!topic/django-
core-mentorship/Ix1rOFihCcE this discussion] on django-core-mentorship.
The thread went dead and as far as I can tell no ticket was added but it
seems like a useful addition to me.)
The [https://groups.google.com/forum/#!topic/django-core-
mentorship/Ix1rOFihCcE current tutorial] on "Writing your first patch for
Django" walks though the process of cloning the repository, installing in
a virtual environment with `pip -e` and the test suite.
This sets people up to start a branch to make changes to Django and run
the tests, however it is not clear on how to make a test Django project
that runs with the modified Django version.
**Suggested updates to documentation**
1. Slightly reword the section explaining to `pip -e` to explain how this
sets up a virtual environment ''within'' the directory where you cloned
Django - and that this becomes the environment you can start making
changes and run the Django testsuite, as explain further on in the
tutorial.
2. Add an "admonition" box, or point to a section later in the document,
to explain:
"Do you want to start a test Django project that reflects the changed
you have made?" explaining that you should make a different directory with
a different virtual env, then pip -e /path/to/your/local/clone/django/
again, and from there go as usual with django-admin.
--
Ticket URL: <https://code.djangoproject.com/ticket/30816>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/054.4d54374353ac0f78a97918061184c7ca%40djangoproject.com.
