bugseverywhere

Last updated: 2015-11-07 00:47:31 +0000

Upstream URL: git clone http://chriswarbo.net/git/bugseverywhere.git

Repo

View repository

View issue tracker

Contents of README follows


Bugs Everywhere

This is Bugs Everywhere (BE), a bugtracker built on distributed version control. It works with Arch, Bazaar, Darcs, Git, Mercurial, and Monotone at the moment, but is easily extensible. It can also function with no VCS at all.

The idea is to package the bug information with the source code, so that bugs can be marked "fixed" in the branches that fix them. So, instead of numbers, bugs have globally unique ids.

Getting BE

BE is available as a Git repository::

<pre><code>$ git clone git://gitorious.org/be/be.git be</code></pre>

See the homepage_ for details. If you do branch the Git repo, you'll need to run::

<pre><code>$ make</code></pre>

to build some auto-generated files (e.g. <code>libbe/_version.py</code>), and::

<pre><code>$ make install</code></pre>

to install BE. By default BE will install into your home directory, but you can tweak the <code>PREFIX</code> variable in <code>Makefile</code> to install to another location.

.. _homepage: http://bugseverywhere.org/

Getting started

To get started, you must set the bugtracker root. Typically, you will want to set the bug root to your project root, so that Bugs Everywhere works in any part of your project tree.::

<pre><code>$ be init -r $PROJECT_ROOT</code></pre>

To create bugs, use <code>be new $DESCRIPTION</code>. To comment on bugs, you can can use <code>be comment $BUG_ID</code>. To close a bug, use <code>be close $BUG_ID</code> or <code>be status $BUG_ID fixed</code>. For more commands, see <code>be help</code>. You can also look at the usage examples in <code>test_usage.sh</code>.

Documentation

If <code>be help</code> isn't scratching your itch, the full documentation is available in the doc directory as reStructuredText_ . You can build the full documentation with Sphinx_ , convert single files with docutils_ , or browse through the doc directory by hand. <code>doc/index.txt</code> is a good place to start. If you do use Sphinx, you'll need to install numpydoc_ for automatically generating API documentation. See the <code>NumPy/SciPy documentation guide</code>_ for an introduction to the syntax.

.. _reStructuredText: http://docutils.sourceforge.net/docs/user/rst/quickref.html .. _Sphinx: http://sphinx.pocoo.org/ .. _docutils: http://docutils.sourceforge.net/ .. _numpydoc: http://pypi.python.org/pypi/numpydoc .. _NumPy/SciPy documentation guide: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt