Add hacking docs.

docs/hacking.rst

@@ -0,0 +1,296 @@
+Hacking on :mod:`zope.catalog`
+==============================
+
+
+Getting the Code
+################
+
+The main repository for :mod:`zope.catalog` is in the Zope Foundation
+Github repository:
+
+  https://github.com/zopefoundation/zope.catalog
+
+You can get a read-only checkout from there:
+
+.. code-block:: sh
+
+   $ git clone https://github.com/zopefoundation/zope.catalog.git
+
+or fork it and get a writeable checkout of your fork:
+
+.. code-block:: sh
+
+   $ git clone git@github.com/jrandom/zope.catalog.git
+
+The project also mirrors the trunk from the Github repository as a
+Bazaar branch on Launchpad:
+
+https://code.launchpad.net/zope.catalog
+
+You can branch the trunk from there using Bazaar:
+
+.. code-block:: sh
+
+   $ bzr branch lp:zope.catalog
+
+
+Working in a ``virtualenv``
+###########################
+
+Installing
+----------
+
+If you use the ``virtualenv`` package to create lightweight Python
+development environments, you can run the tests using nothing more
+than the ``python`` binary in a virtualenv.  First, create a scratch
+environment:
+
+.. code-block:: sh
+
+   $ /path/to/virtualenv --no-site-packages /tmp/hack-zope.catalog
+
+Next, get this package registered as a "development egg" in the
+environment:
+
+.. code-block:: sh
+
+   $ /tmp/hack-zope.catalog/bin/python setup.py develop
+
+Running the tests
+-----------------
+
+Run the tests using the build-in ``setuptools`` testrunner:
+
+.. code-block:: sh
+
+   $ /tmp/hack-zope.catalog/bin/python setup.py test
+   running test
+   .................
+   ----------------------------------------------------------------------
+   Ran 17 tests in 0.000s
+
+   OK
+
+If you have the :mod:`nose` package installed in the virtualenv, you can
+use its testrunner too:
+
+.. code-block:: sh
+
+   $ /tmp/hack-zope.catalog/bin/easy_install nose
+   ...
+   $ /tmp/hack-zope.catalog/bin/nosetests
+   .................
+   ----------------------------------------------------------------------
+   Ran 17 tests in 0.000s
+
+   OK
+
+If you have the :mod:`coverage` pacakge installed in the virtualenv,
+you can see how well the tests cover the code:
+
+.. code-block:: sh
+
+   $ /tmp/hack-zope.catalog/bin/easy_install nose coverage
+   ...
+   $ /tmp/hack-zope.catalog/bin/nosetests --with coverage
+   running nosetests
+   ...................
+   Name                         Stmts   Miss  Cover   Missing
+   ----------------------------------------------------------
+   zope/catalog.py                  0      0   100%   
+   zope/catalog/attribute.py       31      0   100%   
+   zope/catalog/catalog.py        125      0   100%   
+   zope/catalog/field.py           10      0   100%   
+   zope/catalog/interfaces.py      22      0   100%   
+   zope/catalog/keyword.py         13      0   100%   
+   zope/catalog/text.py            15      0   100%   
+   ----------------------------------------------------------
+   TOTAL                          216     16   100%   
+   ----------------------------------------------------------------------
+   Ran 19 tests in 0.554s
+
+   OK
+
+
+Building the documentation
+--------------------------
+
+:mod:`zope.catalog` uses the nifty :mod:`Sphinx` documentation system
+for building its docs.  Using the same virtualenv you set up to run the
+tests, you can build the docs:
+
+.. code-block:: sh
+
+   $ /tmp/hack-zope.catalog/bin/easy_install Sphinx
+   ...
+   $ bin/sphinx-build -b html -d docs/_build/doctrees docs docs/_build/html
+   ...
+   build succeeded.
+
+You can also test the code snippets in the documentation:
+
+.. code-block:: sh
+
+   $ bin/sphinx-build -b doctest -d docs/_build/doctrees docs docs/_build/doctest
+   ...
+
+   Doctest summary
+   ===============
+     117 tests
+       0 failures in tests
+       0 failures in setup code
+   build succeeded.
+   Testing of doctests in the sources finished, look at the  \
+       results in _build/doctest/output.txt.
+
+
+Using :mod:`zc.buildout`
+########################
+
+Setting up the buildout
+-----------------------
+
+:mod:`zope.catalog` ships with its own :file:`buildout.cfg` file and
+:file:`bootstrap.py` for setting up a development buildout:
+
+.. code-block:: sh
+
+   $ /path/to/python2.6 bootstrap.py
+   ...
+   Generated script '.../bin/buildout'
+   $ bin/buildout
+   Develop: '/home/jrandom/projects/Zope/zope.catalog/.'
+   ...
+   Generated script '.../bin/sphinx-quickstart'.
+   Generated script '.../bin/sphinx-build'.
+
+Running the tests
+-----------------
+
+Run the tests:
+
+.. code-block:: sh
+
+   $ bin/test --all
+   Running zope.testing.testrunner.layer.UnitTests tests:
+     Set up zope.testing.testrunner.layer.UnitTests in 0.000 seconds.
+     Ran 400 tests with 0 failures and 0 errors in 0.366 seconds.
+   Tearing down left over layers:
+     Tear down zope.testing.testrunner.layer.UnitTests in 0.000 seconds.
+
+
+Using :mod:`tox`
+################
+
+Running Tests on Multiple Python Versions
+-----------------------------------------
+
+`tox <http://tox.testrun.org/latest/>`_ is a Python-based test automation
+tool designed to run tests against multiple Python versions.  It creates
+a ``virtualenv`` for each configured version, installs the current package
+and configured dependencies into each ``virtualenv``, and then runs the
+configured commands.
+
+:mod:`zope.catalog` configures the following :mod:`tox` environments via
+its ``tox.ini`` file:
+
+- The ``py26``, ``py27``, ``py33``, ``py34``, and ``pypy`` environments
+  builds a ``virtualenv`` with the appropriate interpreter,
+  installs :mod:`zope.catalog` and dependencies, and runs the tests
+  via ``python setup.py test -q``.
+
+- The ``coverage`` environment builds a ``virtualenv`` with ``python2.6``,
+  installs :mod:`zope.catalog`, installs
+  :mod:`nose` and :mod:`coverage`, and runs ``nosetests`` with statement
+  coverage.
+
+- The ``docs`` environment builds a virtualenv with ``python2.6``, installs
+  :mod:`zope.catalog`, installs ``Sphinx`` and
+  dependencies, and then builds the docs and exercises the doctest snippets.
+
+This example requires that you have a working ``python2.6`` on your path,
+as well as installing ``tox``:
+
+.. code-block:: sh
+
+   $ tox -e py26
+   GLOB sdist-make: .../zope.interface/setup.py
+   py26 sdist-reinst: .../zope.interface/.tox/dist/zope.interface-4.0.2dev.zip
+   py26 runtests: commands[0]
+   ..........
+   ----------------------------------------------------------------------
+   Ran 17 tests in 0.152s
+
+   OK
+   ___________________________________ summary ____________________________________
+   py26: commands succeeded
+   congratulations :)
+
+Running ``tox`` with no arguments runs all the configured environments,
+including building the docs and testing their snippets:
+
+.. code-block:: sh
+
+   $ tox
+   GLOB sdist-make: .../zope.interface/setup.py
+   py26 sdist-reinst: .../zope.interface/.tox/dist/zope.interface-4.0.2dev.zip
+   py26 runtests: commands[0]
+   ...
+   Doctest summary
+   ===============
+    117 tests
+      0 failures in tests
+      0 failures in setup code
+      0 failures in cleanup code
+   build succeeded.
+   ___________________________________ summary ____________________________________
+   py26: commands succeeded
+   py27: commands succeeded
+   py33: commands succeeded
+   py34: commands succeeded
+   pypy: commands succeeded
+   coverage: commands succeeded
+   docs: commands succeeded
+   congratulations :)
+
+
+Contributing to :mod:`zope.catalog`
+###################################
+
+Submitting a Bug Report
+-----------------------
+
+:mod:`zope.catalog` tracks its bugs on Github:
+
+  https://github.com/zopefoundation/zope.catalog/issues
+
+Please submit bug reports and feature requests there.
+
+
+Sharing Your Changes
+--------------------
+
+.. note::
+
+   Please ensure that all tests are passing before you submit your code.
+   If possible, your submission should include new tests for new features
+   or bug fixes, although it is possible that you may have tested your
+   new code by updating existing tests.
+
+If have made a change you would like to share, the best route is to fork
+the Githb repository, check out your fork, make your changes on a branch
+in your fork, and push it.  You can then submit a pull request from your
+branch:
+
+  https://github.com/zopefoundation/zope.catalog/pulls
+
+If you branched the code from Launchpad using Bazaar, you have another
+option:  you can "push" your branch to Launchpad:
+
+.. code-block:: sh
+
+   $ bzr push lp:~jrandom/zope.catalog/cool_feature
+
+After pushing your branch, you can link it to a bug report on Launchpad,
+or request that the maintainers merge your branch using the Launchpad
+"merge request" feature.

docs/index.rst

@@ -8,6 +8,7 @@ Contents:
 
    narrative
    api
+   hacking
 
 
 Indices and tables