[Django] #30816: Add or clarify documentation for contributing to Django (running Django tests vs testing a Django project)
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.
Django
tests vs testing a Django project)
Reporter: Ad Timmering | Owner: nobody
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Ad Timmering):
* type: Uncategorized => Cleanup/optimization
* component: Uncategorized => Documentation
--
Ticket URL: <https://code.djangoproject.com/ticket/30816#comment:1>
Django
--------------------------------------+------------------------------------
Reporter: Ad Timmering | Owner: nobody
Component: Documentation | Version: master
Severity: Normal | Resolution:
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by felixxm):
* stage: Unreviewed => Accepted
Comment:
I agree that we can evaluate a patch in this area.
--
Ticket URL: <https://code.djangoproject.com/ticket/30816#comment:2>
Django
Reporter: Ad Timmering | Owner: Ad
Type: | Timmering
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Ad Timmering):
* owner: nobody => Ad Timmering
* status: new => assigned
Comment:
Great, I'll draft something in next 1-2 weeks.
--
Ticket URL: <https://code.djangoproject.com/ticket/30816#comment:3>
Django
-------------------------------------+-------------------------------------
Reporter: Ad Timmering | Owner: Ad
Type: | Timmering
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Ad Timmering):
* has_patch: 0 => 1
Comment:
Added a PR for suggested edit. Comments/views appreciated!
--
Ticket URL: <https://code.djangoproject.com/ticket/30816#comment:4>
Django
-------------------------------------+-------------------------------------
Reporter: Ad Timmering | Owner: Ad
Type: | Timmering
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"573350475274d23d7bc20ae35e52edf50a09fd6d" 57335047]:
{{{
#!CommitTicketReference repository=""
revision="573350475274d23d7bc20ae35e52edf50a09fd6d"
[2.2.x] Fixed #30816 -- Doc'd how to create projects with a local copy of
Django.
Backport of dee687e93a2d45e9fac404be2098cc4707d31c1f from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/30816#comment:6>
Django
-------------------------------------+-------------------------------------
Reporter: Ad Timmering | Owner: Ad
Type: | Timmering
Cleanup/optimization | Status: closed
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Mariusz Felisiak <felisiak.mariusz@…>):
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"18631226da2fb75d40e73df8f1049f928848f794" 1863122]:
{{{
#!CommitTicketReference repository=""
revision="18631226da2fb75d40e73df8f1049f928848f794"
[3.0.x] Fixed #30816 -- Doc'd how to create projects with a local copy of
Django.
Backport of dee687e93a2d45e9fac404be2098cc4707d31c1f from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/30816#comment:5>
Django
-------------------------------------+-------------------------------------
Reporter: Ad Timmering | Owner: Ad
Type: | Timmering
Cleanup/optimization | Status: closed
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"dee687e93a2d45e9fac404be2098cc4707d31c1f" dee687e]:
{{{
#!CommitTicketReference repository=""
revision="dee687e93a2d45e9fac404be2098cc4707d31c1f"
Fixed #30816 -- Doc'd how to create projects with a local copy of Django.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/30816#comment:7>