Documentation for running tests difficult to find

[Michael Radziej]

Somebody who just wants to run the django testsuite (and not actually contribute) will probably not look up "how to contribute" in the django docs, so he cannot find the documentation on how to run the testsuite. Please provide a simple explanation or refer to the docs in the toplevel README (as long as we cannot do a "setup.py test")

[Russell Keith-Magee]

Agreed; it's generally good practice to document how to run the tests as part of your README (or at least to provide a link to where such instructions are documented).

[Greg Turner]

Patch attached and at ​https://github.com/cogat/django/commit/16e0b83c1ea18d9a5fab8bff4f7e754022c4d6f4.

I also updated the running tests documentation to be clearer and make it easier to get started.

[Greg Turner]

Sorry, wrong SHA: ​https://github.com/cogat/django/commit/2237ab16faf770c3c6ed8dc72ffdbd085d429a1d

[Gabriel Grant]

mostly looks good to me, spare a few little things:

I believe link on README line 44 should read:
​http://docs.djangoproject.com/en/dev/internals/contributing/#running-the-unit-tests
(note the changed anchor)

I'm a bit concerned about telling people to ​install by manually putting this version in site-packages (docs/internals/contributing.txt, line 894). For the quick start, I've suggested simply symlinking django into the test directory (as well as pointed them to to the other options).

As an aside, ​these instructions could probably use to be updated (pip, anyone?)

I've uploaded a patch with the adding the new changes.

[Gabriel Grant]

additional changes to the original patch

[Greg Turner]

I agree with all of gg's suggestions.

[Greg Turner]

gg's patch applied at ​https://github.com/cogat/django/commit/6eca02df4091ea1ccf5b9c6b9f09ae84a85d9694

[Gabriel Grant]

cogat's final version is RFC

[Gabriel Grant]

this patch contains all the changes from the above two patches, as well as a few extra line-length fixes

[Russell Keith-Magee]

(In [15342]) Fixed #13662 -- Added an entry in the README to direct people to the instructions for running the test suite, and cleaned up that section of the docs. Thanks to mir for the report, and to cogat and gg for the draft text.

[Russell Keith-Magee]

(In [15345]) [1.2.X] Fixed #13662 -- Added an entry in the README to direct people to the instructions for running the test suite, and cleaned up that section of the docs. Thanks to mir for the report, and to cogat and gg for the draft text.

Backport of r15342 from trunk.

[Jacob]

Milestone 1.3 deleted