|
|
@@ -7,14 +7,13 @@ Some ground rules:
|
|
7
|
7
|
* To avoid disappointment, new features should be discussed on the mailing list
|
|
8
|
8
|
(django-oscar@googlegroups.com) before serious work starts.
|
|
9
|
9
|
|
|
10
|
|
-* Pull requests will be rejected if sufficient tests aren't provided.
|
|
|
10
|
+* Write tests! Pull requests will be rejected if sufficient tests aren't
|
|
|
11
|
+ provided. See the guidance below on the testing conventions that oscar uses
|
|
11
|
12
|
|
|
12
|
13
|
* Make pull requests against Oscar's master branch unless instructed otherwise.
|
|
13
|
14
|
|
|
14
|
15
|
* Please update the documentation when altering behaviour or introducing new features.
|
|
15
|
16
|
|
|
16
|
|
-* Follow the conventions (see below).
|
|
17
|
|
-
|
|
18
|
17
|
Installation
|
|
19
|
18
|
============
|
|
20
|
19
|
|
|
|
@@ -54,7 +53,7 @@ To run an individual test, use one of::
|
|
54
|
53
|
|
|
55
|
54
|
Oscar's testrunner uses the progressive_ plugin when running all tests, but uses
|
|
56
|
55
|
the spec_ plugin when running a subset. It is a good practice to name your test
|
|
57
|
|
-cases and methods so that the spec output reads correctly. For example::
|
|
|
56
|
+cases and methods so that the spec output reads well. For example::
|
|
58
|
57
|
|
|
59
|
58
|
$ ./runtests.py tests/unit/offer/benefit_tests.py:TestAbsoluteDiscount
|
|
60
|
59
|
nosetests --verbosity 1 tests/unit/offer/benefit_tests.py:TestAbsoluteDiscount -s -x --with-spec
|
|
|
@@ -93,7 +92,8 @@ Oscar using a browser. Set it up by::
|
|
93
|
92
|
cd sites/sandbox
|
|
94
|
93
|
./manage.py runserver
|
|
95
|
94
|
|
|
96
|
|
-This will create the database and load some fixtures.
|
|
|
95
|
+This will create the database and load some fixtures for categories and shipping
|
|
|
96
|
+countries.
|
|
97
|
97
|
|
|
98
|
98
|
Writing docs
|
|
99
|
99
|
============
|
|
|
@@ -127,7 +127,7 @@ URLs
|
|
127
|
127
|
``/dashboard/notifications/3/``. If there is a distinction between the detail
|
|
128
|
128
|
page and the update page, use ``/dashboard/notifications/3/update/``.
|
|
129
|
129
|
|
|
130
|
|
-* Delete pages, eg /dashboard/notifications/3/delete/
|
|
|
130
|
+* Delete pages, eg ``/dashboard/notifications/3/delete/``
|
|
131
|
131
|
|
|
132
|
132
|
View class names
|
|
133
|
133
|
----------------
|