From dd6b3ee576e3d9d712ea349686861ec52574272c Mon Sep 17 00:00:00 2001 From: Ralf Gommers Date: Wed, 28 Oct 2009 23:09:48 +0100 Subject: [PATCH] Add some docs for 'make coverage'. --- DEVELOPMENT.txt | 46 +++++++++++++++++++++++++++++++++++++++ doc/source/contribute.txt | 2 +- 2 files changed, 47 insertions(+), 1 deletion(-) create mode 100644 DEVELOPMENT.txt diff --git a/DEVELOPMENT.txt b/DEVELOPMENT.txt new file mode 100644 index 00000000..61b6f7eb --- /dev/null +++ b/DEVELOPMENT.txt @@ -0,0 +1,46 @@ +Development process +------------------- + * Go to `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 `_ + (also see `LWN article `_). + +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 `_ + as NumPy and SciPy. + * Follow the `Python PEPs `_ + where possible. + * All major changes should be `posted for review + `_ to the `mailing list + `_. + +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 ``_ and then run:: + + $ make coverage + +This will print a report with one line for each file in `scikits.image`, +detailing the test coverage. + +Bugs +```` +Please `report bugs on Github `_. + diff --git a/doc/source/contribute.txt b/doc/source/contribute.txt index 8ed8e081..5e62b585 100644 --- a/doc/source/contribute.txt +++ b/doc/source/contribute.txt @@ -1,2 +1,2 @@ .. include:: ../../TASKS.txt - +.. include:: ../../DEVELOPMENT.txt