Skip to content

Commit

Permalink
more intuitive description for beginner contributor to get her hands …
Browse files Browse the repository at this point in the history
…on documentation
Rate limit · GitHub

Access has been restricted

You have triggered a rate limit.

Please wait a few minutes before you try again;
in some cases this may take up to an hour.

mkcor committed Dec 19, 2012
1 parent 7c0424f commit 112eb41
Showing 2 changed files with 22 additions and 16 deletions.
30 changes: 18 additions & 12 deletions DEVELOPMENT.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
Development process
-------------------

:doc:`Read this overview <gitwash/index>` 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
<http://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 <http://groups.google.com/group/scikit-image>`_ to explain your changes.

Read these :doc:`detailed documents <gitwash/index>` on how to use Git with
``scikit-image`` (`<http://scikit-image.org/docs/dev/gitwash/index.html>`_).

.. 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 <http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines>`_
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 <http://nedbatchelder.com/code/coverage/>`__
@@ -98,5 +103,6 @@ detailing the test coverage::
...

Bugs
````
Please `report bugs on Github <https://github.com/scikit-image/scikit-image/issues>`_.
----

Please `report bugs on GitHub <https://github.com/scikit-image/scikit-image/issues>`_.
8 changes: 4 additions & 4 deletions TASKS.txt
Original file line number Diff line number Diff line change
@@ -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 <http://groups.google.com/group/scikit-image>`_ 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 <gitwash/index>` when developing skimage
* If you're looking something to implement, you can find a list of `requested features on github <https://github.com/scikit-image/scikit-image/wiki/Requested-features>`__. In addition, you can browse the `open issues on github <https://github.com/scikit-image/scikit-image/issues?state=open>`__.
* If you're looking for something to implement, you can find a list of `requested features on GitHub <https://github.com/scikit-image/scikit-image/wiki/Requested-features>`__. In addition, you can browse the `open issues on GitHub <https://github.com/scikit-image/scikit-image/issues?state=open>`__.
* The technical detail of the `development process`_ is summed up below.
Refer to the :doc:`gitwash <gitwash/index>` for a step-by-step tutorial.

.. contents::
:local:

0 comments on commit 112eb41

Please sign in to comment.