From 112eb41c1fcb2e0f89836f63112b8a9bed5923a7 Mon Sep 17 00:00:00 2001 From: Marianne Corvellec Date: Wed, 19 Dec 2012 23:28:52 +0100 Subject: [PATCH] more intuitive description for beginner contributor to get her hands on documentation --- DEVELOPMENT.txt | 30 ++++++++++++++++++------------ TASKS.txt | 8 ++++---- 2 files changed, 22 insertions(+), 16 deletions(-) diff --git a/DEVELOPMENT.txt b/DEVELOPMENT.txt index 509cf322..8726394b 100644 --- a/DEVELOPMENT.txt +++ b/DEVELOPMENT.txt @@ -1,8 +1,7 @@ Development process ------------------- -:doc:`Read this overview ` of how to use Git with -``skimage``. Here's the long and short of it: +Here's the long and short of it: * Go to `https://github.com/scikit-image/scikit-image `_ and follow the @@ -11,9 +10,12 @@ Development process branch name will appear in the merge message, use a sensible name such as 'transform-speedups'. * Commit locally as you progress. - * Push your changes back to github and create a pull request by - clicking "request pull" in GitHub. - * Optionally, mail the mailing list, explaining your changes. + * Push your changes back to GitHub and create a Pull Request by + clicking 'Pull Request' in GitHub. + * Optionally, post on the `mailing list `_ to explain your changes. + +Read these :doc:`detailed documents ` on how to use Git with +``scikit-image`` (``_). .. note:: @@ -33,8 +35,9 @@ project on how they manage to keep review overhead to a minimum: http://mail.scipy.org/pipermail/ipython-dev/2010-October/006746.html Guidelines -`````````` - * All code should have tests (see "Test coverage" below for more details). +---------- + + * All code should have tests (see `test coverage`_ below for more details). * All code should be documented, to the same `standard `_ as NumPy and SciPy. For new functionality, always add an example to the @@ -47,7 +50,8 @@ Guidelines * Examples in the gallery should have a maximum figure width of 8 inches. Stylistic Guidelines -```````````````````` +-------------------- + * Use numpy data types instead of strings (``np.uint8`` instead of ``"uint8"``). @@ -78,9 +82,10 @@ Stylistic Guidelines hough(canny(my_image)) Test coverage -````````````` +------------- + Tests for a module should ideally cover all code in that module, -i.e. statement coverage should be at 100%. +i.e., statement coverage should be at 100%. To measure the test coverage, install `coverage.py `__ @@ -98,5 +103,6 @@ detailing the test coverage:: ... Bugs -```` -Please `report bugs on Github `_. +---- + +Please `report bugs on GitHub `_. diff --git a/TASKS.txt b/TASKS.txt index a2fcffe2..0046b6a3 100644 --- a/TASKS.txt +++ b/TASKS.txt @@ -15,14 +15,14 @@ How to contribute to ``skimage`` cell_profiler -Developing Open Source is great fun! Join us on the `skimage mailing +Developing Open Source is great fun! Join us on the `scikit-image mailing list `_ and tell us which of the following challenges you'd like to solve. * Mentoring is available for those new to scientific programming in Python. -* The technical detail of the `development process`_ is given below. -* :doc:`How to use GitHub ` when developing skimage -* If you're looking something to implement, you can find a list of `requested features on github `__. In addition, you can browse the `open issues on github `__. +* If you're looking for something to implement, you can find a list of `requested features on GitHub `__. In addition, you can browse the `open issues on GitHub `__. +* The technical detail of the `development process`_ is summed up below. + Refer to the :doc:`gitwash ` for a step-by-step tutorial. .. contents:: :local: