Merge branch 'coverage' of git://github.com/rgommers/scikits.image

This commit is contained in:
Stefan van der Walt
2009-11-03 00:13:21 +02:00
5 changed files with 55 additions and 40 deletions
+52
View File
@@ -0,0 +1,52 @@
Development process
-------------------
* Go to `http://github.com/stefanv/scikits.image
<http://github.com/stefanv/scikits.image>`_ and follow the instructions on
making your own fork/branch.
* Make changes to your branch, committing locally as you progress.
* Push your changes back to github.
* Ping stefan to request a merge into the main development branch.
.. note::
Do *not* merge the main branch into yours. You may rebase,
as long as you are `aware of its dangers <http://tinyurl.com/lll385>`_
(also see `LWN article <http://tinyurl.com/nqcbkj>`_).
All of this may be intimidating if you've never used git before, so we'd
happily accept plain old unified diffs (``git diff`` or ``diff -u a.txt
b.txt``) as well.
Guidelines:
```````````
* All code should have tests (see "Test coverage" below for more details).
* All code should be documented, to the same
`standard <http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines>`_
as NumPy and SciPy.
* Follow the `Python PEPs <http://www.python.org/dev/peps/pep-0008/>`_
where possible.
* All major changes should be `posted for review
<http://codereview.appspot.com>`_ to the `mailing list
<http://groups.google.com/group/scikits-image>`_.
Test coverage
`````````````
Tests for a module should ideally cover all code in that module, i.e. statement
coverage should be at 100%. To measure the test coverage, install `<coverage.py
http://nedbatchelder.com/code/coverage/>`_ and then run::
$ make coverage
This will print a report with one line for each file in `scikits.image`,
detailing the test coverage::
Name Stmts Exec Cover Missing
------------------------------------------------------------------------------
scikits/image/color/colorconv 77 77 100%
scikits/image/filter/__init__ 1 1 100%
...
Bugs
````
Please `report bugs on Github <http://github.com/stefanv/scikits.image/issues>`_.
+1 -2
View File
@@ -10,5 +10,4 @@ test:
nosetests scikits/image
coverage:
nosetests scikits/image --with-coverage
coverage -r -m scikits/image/*.py scikits/image/*/*.py
nosetests scikits/image --with-coverage --cover-package=scikits.image
+1 -36
View File
@@ -24,7 +24,7 @@ or tests.
* `Hough transform <http://mentat.za.net>`_
* `Shortest paths <http://mentat.za.net>`_
* `Grey-level co-occurrence matrices <http://mentat.za.net/hg>`_
* Marching squares (investigate patent issues)
* Marching squares
* Nadav's bilateral filtering (first compare against CellProfile's code)
* 2D iso-contour finding (sub-pixel precision) [ask Zach Pincus]
* 2D image warping via thin-plate splines [ask Zach Pincus]
@@ -96,38 +96,3 @@ checking in the API files into the repository (done) -- but the doc build
process needs to be updated to use these distributed files if they cannot be
generated from source.
Development process
-------------------
* Go to `http://github.com/stefanv/scikits.image
<http://github.com/stefanv/scikits.image>`_ and follow the instructions on
making your own fork/branch.
* Make changes to your branch, committing locally as you progress.
* Push your changes back to github.
* Ping stefan to request a merge into the main development branch.
.. note::
Do *not* merge the main branch into yours. You may rebase,
as long as you are `aware of its dangers <http://tinyurl.com/lll385>`_
(also see `LWN article <http://tinyurl.com/nqcbkj>`_).
All of this may be intimidating if you've never used git before, so we'd
happily accept plain old unified diffs (``git diff`` or ``diff -u a.txt
b.txt``) as well.
Guidelines:
```````````
* All code should have tests.
* All code should be documented, to the same
`standard <http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines>`_
as NumPy and SciPy.
* Follow the `Python PEPs <http://www.python.org/dev/peps/pep-0008/>`_
where possible.
* All major changes should be `posted for review
<http://codereview.appspot.com>`_ to the `mailing list
<http://groups.google.com/group/scikits-image>`_.
Bugs
````
Please `report bugs on Github <http://github.com/stefanv/scikits.image>`_.
-1
View File
@@ -8,5 +8,4 @@ API Reference
scikits.image.color
scikits.image.filter
scikits.image.io
scikits.image.opencv
scikits.image.transform
+1 -1
View File
@@ -1,2 +1,2 @@
.. include:: ../../TASKS.txt
.. include:: ../../DEVELOPMENT.txt