Skip to content

Commit cdcea94

Browse files
committed
note whitespace rules, explain setup.py dev
1 parent 4a11446 commit cdcea94

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

HACKING.txt

+10-5
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,13 @@ checkout.
3030
$ env/bin/easy_install setuptools-git
3131

3232
- Install Pyramid from the checkout into the virtualenv using ``setup.py
33-
develop`` (running ``setup.py develop`` *must* be done while the current
34-
working directory is the ``pyramid`` checkout directory)::
33+
dev``. ``setup.py dev`` is an alias for "setup.py develop" which also
34+
installs testing requirements such as nose and coverage. Running
35+
``setup.py dev`` *must* be done while the current working directory is the
36+
``pyramid`` checkout directory::
3537

3638
$ cd pyramid
37-
$ ../env/bin/python setup.py develop
39+
$ ../env/bin/python setup.py dev
3840

3941
- At that point, you should be able to create new Pyramid projects by using
4042
``pcreate``::
@@ -85,6 +87,9 @@ Coding Style
8587
2 newlines between classes. But 80-column lines, in particular, are
8688
mandatory.
8789

90+
- Please do not remove trailing whitespace. Configure your editor to reduce
91+
diff noise.
92+
8893
Running Tests
8994
--------------
9095

@@ -110,8 +115,8 @@ Test Coverage
110115

111116
- The codebase *must* have 100% test statement coverage after each commit.
112117
You can test coverage via ``tox -e coverage``, or alternately by installing
113-
``nose`` and ``coverage`` into your virtualenv, and running ``setup.py
114-
nosetests --with-coverage``.
118+
``nose`` and ``coverage`` into your virtualenv (easiest via ``setup.py
119+
dev``) , and running ``setup.py nosetests --with-coverage``.
115120

116121
Documentation Coverage and Building HTML Documentation
117122
------------------------------------------------------

0 commit comments

Comments
 (0)