Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Bugs Everywhere is a “distributed bugtracker” designed to complement distributed revision control systems
Python Shell
Branch: master

Added 'be gui' command to invoke BEurtle GUI for you.

latest commit b1f92d9b96
Niall Douglas (s [underscore] sourceforge {at} nedprod [dot] com) authored
Failed to load latest commit information.
.be Generated libbe/_version.py was not UTF-8 aware.
doc Ran update-copyright.py.
interfaces Ran update-copyright.py.
libbe Added 'be gui' command to invoke BEurtle GUI for you.
misc Ran update-copyright.py.
notworking Several hacks to make BE compatible with bbfreeze and therefore compi…
update-copyright @ 5ab3ec3 Update update-copyright to version 0.3.
!Generate_exe_bbfreeze.py Make sure all .py are compiled before running bbfreeze
!Generate_version.bat Added libbe version generation for Windows
.gitignore Fix .gitignore
.gitmodules Add update-copyright as a submodule and update release.py accordingly.
.mailmap Add .mailmap, mapping Git committers and authors to canonical names.
.update-copyright.conf Transition to my external update-copyright package.
AUTHORS Ran update-copyright.py.
COPYING Merged with head branch
Makefile Ran update-copyright.py.
NEWS Add --notify to `be serve`.
README.master Several hacks to make BE compatible with bbfreeze and therefore compi…
Readme.txt Fixed broken CR/LF
be Ran update-copyright.py.
be.bat Added be.bat so BE runs on Windows
be.py Several hacks to make BE compatible with bbfreeze and therefore compi…
distribute_setup.py Fixed missing pyyaml dependency on Windows. Now auto-downloads a copy…
release.py Add update-copyright as a submodule and update release.py accordingly.
setup.py Fixed small bug where running from inside zip support was over prefer…
test.py Ran update-copyright.py.
test_upgrade.py
test_usage.sh Update test_usage.sh

README.master

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::

    $ git clone git://gitorious.org/be/be.git be

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

    $ make

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

    $ make install

to install BE.  By default BE will install into your home directory,
but you can tweak the ``PREFIX`` variable in ``Makefile`` 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.::

    $ be init -r $PROJECT_ROOT

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


Documentation
=============

If ``be help`` 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.
doc/index.txt is a good place to start.  If you do use Sphinx, you'll
need to install numpydoc_ for automatically generating API
documentation.  See the ``NumPy/SciPy documentation guide``_ 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:
  http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines
Something went wrong with that request. Please try again.