Skip to content

Commit

Permalink
Update hacking docs to reflect Github.
Browse files Browse the repository at this point in the history
  • Loading branch information
tseaver committed Jan 12, 2015
1 parent 937b7a1 commit bf4895e
Showing 1 changed file with 48 additions and 41 deletions.
89 changes: 48 additions & 41 deletions docs/hacking.rst
Expand Up @@ -3,18 +3,24 @@ Hacking on :mod:`zope.interface`


Getting the Code
-----------------
################

The main repository for :mod:`zope.interface` is in the Zope Subversion
repository:
The main repository for :mod:`zope.interface` is in the Zope Foundation
Github repository:

http://svn.zope.org/zope.interface
https://github.com/zopefoundation/zope.interface

You can get a read-only Subversion checkout from there:
You can get a read-only checkout from there:

.. code-block:: sh
$ svn checkout svn://svn.zope.org/repos/main/zope.interface/trunk zope.interface
$ git clone https://github.com/zopefoundation/zope.interface.git
or fork it and get a writeable checkout of your fork:

.. code-block:: sh
$ git clone git@github.com/jrandom/zope.interface.git
The project also mirrors the trunk from the Subversion repository as a
Bazaar branch on Launchpad:
Expand All @@ -28,8 +34,11 @@ You can branch the trunk from there using Bazaar:
$ bzr branch lp:zope.interface
Running the tests in a ``virtualenv``
-------------------------------------
Working in a ``virtualenv``
###########################

Running the tests
-----------------

If you use the ``virtualenv`` package to create lightweight Python
development environments, you can run the tests using nothing more
Expand Down Expand Up @@ -107,8 +116,8 @@ you can see how well the tests cover the code:
OK
Building the documentation in a ``virtualenv``
----------------------------------------------
Building the documentation
--------------------------

:mod:`zope.interface` uses the nifty :mod:`Sphinx` documentation system
for building its docs. Using the same virtualenv you set up to run the
Expand Down Expand Up @@ -152,8 +161,12 @@ You can also test the code snippets in the documentation:
results in docs/_build/doctest/output.txt.
Running the tests using :mod:`zc.buildout`
-------------------------------------------
Using :mod:`zc.buildout`
########################

Setting up the buildout
-----------------------

:mod:`zope.interface` ships with its own :file:`buildout.cfg` file and
:file:`bootstrap.py` for setting up a development buildout:
Expand All @@ -169,6 +182,9 @@ Running the tests using :mod:`zc.buildout`
Generated script '.../bin/sphinx-quickstart'.
Generated script '.../bin/sphinx-build'.
Running the tests
-----------------

You can now run the tests:

.. code-block:: sh
Expand All @@ -181,14 +197,12 @@ You can now run the tests:
Tear down zope.testing.testrunner.layer.UnitTests in 0.000 seconds.
Building the documentation using :mod:`zc.buildout`
---------------------------------------------------
Building the documentation
--------------------------

The :mod:`zope.interface` buildout installs the Sphinx scripts required to
build the documentation, including testing its code snippets:

.. todo:: verify this!

.. code-block:: sh
$ cd docs
Expand Down Expand Up @@ -218,8 +232,12 @@ build the documentation, including testing its code snippets:
Build finished. The HTML pages are in .../docs/_build/html.
Running Tests on Multiple Python Versions via :mod:`tox`
--------------------------------------------------------
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
Expand All @@ -230,19 +248,8 @@ configured commands.
:mod:`zope.interface` configures the following :mod:`tox` environments via
its ``tox.ini`` file:

- The ``py26`` environment builds a ``virtualenv`` with ``python2.6``,
installs :mod:`zope.interface` and dependencies, and runs the tests
via ``python setup.py test -q``.

- The ``py27`` environment builds a ``virtualenv`` with ``python2.7``,
installs :mod:`zope.interface` and dependencies, and runs the tests
via ``python setup.py test -q``.

- The ``py32`` environment builds a ``virtualenv`` with ``python3.2``,
installs :mod:`zope.interface` and dependencies, and runs the tests
via ``python setup.py test -q``.

- The ``pypy`` environment builds a ``virtualenv`` with ``pypy``,
- The ``py26``, ``py27``, ``py33``, ``py34``, and ``pypy`` environments
builds a ``virtualenv`` with ``pypy``,
installs :mod:`zope.interface` and dependencies, and runs the tests
via ``python setup.py test -q``.

Expand Down Expand Up @@ -300,12 +307,16 @@ including building the docs and testing their snippets:
congratulations :)
Contributing to :mod:`zope.interface`
#####################################

Submitting a Bug Report
-----------------------

:mod:`zope.interface` tracks its bugs on Launchpad:
:mod:`zope.interface` tracks its bugs on Github:

https://bugs.launchpad.net/zope.interface
https://github.com/zopefoundation/zope.interface/issues

Please submit bug reports and feature requests there.

Expand All @@ -320,16 +331,12 @@ Sharing Your Changes
or bug fixes, although it is possible that you may have tested your
new code by updating existing tests.

If you got a read-only checkout from the Subversion repository, and you
have made a change you would like to share, the best route is to let
Subversion help you make a patch file:

.. code-block:: sh
$ svn diff > zope.interface-cool_feature.patch
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:

You can then upload that patch file as an attachment to a Launchpad bug
report.
https://github.com/zopefoundation/zope.interface/pulls

If you branched the code from Launchpad using Bazaar, you have another
option: you can "push" your branch to Launchpad:
Expand Down

0 comments on commit bf4895e

Please sign in to comment.