README.md

   1 # Debbugs #
   2
   3 ## Debian Bug-Tracking System ##
   4
   5 ********************************
   6
   7 ### Developers ###
   8
   9 This bug tracking system was developed by Ian Jackson from 1994-1997,
  10 with assistance from nCipher Corporation Limited in 1997.  nCipher allowed
  11 Ian to redistribute modifications he made to the system while working as an
  12 employee of nCipher.
  13
  14 Since then, it has been developed by the various administrators of
  15 bugs.debian.org, including Darren Benham, Adam Heath, Josip Rodin, Anthony
  16 Towns, and Colin Watson.  As in the case of Ian, nCipher allowed Colin to
  17 redistribute modifications he made while working as an employee of nCipher.
  18
  19 ### System Requirements ###
  20
  21  * GNU date
  22  * GNU gzip
  23  * Perl 5 (5.005 is known to work)
  24  * Mailtools and MIME-tools perl modules to manipulate email
  25  * Lynx 2.7 or later
  26  * The bug system requires its own mail domain. It comes with code
  27    which understands how exim, qmail and sendmail deliver mail for such a
  28    domain to a script.
  29  * A webserver. For the old system of static HTML pages generated for
  30    bug reports and index pages, this is easiest if the bug system can
  31    write directly to the webspace; for the new system of CGI scripts
  32    that generate web pages on the fly, write access is not required.
  33  * Somewhere to run CGI scripts (unless you don't need the web forms for
  34    searching for bugs by number, package, maintainer or submitter).
  35
  36 ### Installation Instructions ###
  37
  38 Install the Debian package and read `/usr/share/doc/debbugs/README.Debian` file.
  39
  40 If you can't use the `.deb`, do the following:
  41
  42 1. Run `make install` from the source directory.
  43
  44 2. Edit the config files in `/etc/debbugs/` directory to suit your needs.
  45    Re-run debbugsconfig when you're finished to regenerate the documentation.
  46
  47 3. Set up the mail arrangements to deliver mail to the right place, and to set
  48    up a blackhole mail alias if you need one.  Ensure that `owner@bugs`, the
  49    address of the BTS owner, if that's what you're using, is handled by the MTA.
  50    All other email should be piped into the receive script.
  51
  52 4. Set up your HTTP server to point people looking for bug reports to
  53    `/var/lib/debbugs/www` and set `/var/lib/debbugs/www/cgi` as a valid CGI
  54    directory.
  55
  56 5. Test things a bit, by sending mail messages to the bug system and running
  57    `/usr/lib/debbugs/processall` and/or `/usr/lib/debbugs/rebuild`.  The latter
  58    updates index files used by the CGI scripts.  If you're feeling brave, you
  59    can link `/var/lib/debbugs/spool/index.db` to `index.db.realtime` and
  60    `.../index.archive` to `index.archive.realtime` to remove the need for the
  61    rebuild script; this is still semi-experimental.
  62
  63 6. If all seems well then install the crontab from
  64    `/usr/share/doc/debbugs/examples/crontab`.
  65
  66 Note that each line of `/etc/debbugs/Maintainers` file needs to be formatted as
  67 follows:
  68
  69     package    maintainer name <email@address>
  70
  71 If you need a template, look in `/usr/share/doc/debbugs/examples/` directory.
  72
  73 ### Contributing to Debbugs ###
  74
  75 #### Getting the Source Code ####
  76
  77 Debbugs is managed in git. You can clone the repository into your local
  78 workspace as follows:
  79
  80     git clone http://bugs-master.debian.org/debbugs-source/debbugs.git
  81
  82 Additional branches are available from:
  83
  84  * [Don Armstrong](http://git.donarmstrong.com/debbugs.git/)
  85
  86 Make a working branch for your code and check it out to start working:
  87
  88     git checkout -b example-branch
  89
  90 Stage and commit your changes using appropriate commit messages
  91
  92     git add example-file
  93
  94     git commit -m "Created an example file to demonstrate basic git commands."
  95
  96 #### Submitting a Patch ####
  97
  98 Submitting a patch can be done using git format-patch.
  99
 100 For example
 101
 102     git format-patch origin/master
 103
 104 Creates `.patch` files for all commits since the branch diverged from master.
 105
 106 Debbugs bugs are tracked using debbugs (what else). Patches should therefore be
 107 attached to the bug report for the issue. This can be done by emailing the
 108 `.patch` files to `xxxx@bugs.debian.org` (where xxxx is the bug number).
 109
 110 Feature patches can also be emailed to the maintaining list at
 111 [Debugs mailing list](debian-debbugs@lists.debian.org)
 112
 113 ### Further Information ###
 114
 115 #### Email ####
 116
 117 * Mailing List <debian-debbugs@lists.debian.org>
 118
 119 * To subscribe to the mailing list, email
 120   <debian-debbugs-request@lists.debian.org> with the word "subscribe" in the
 121   subject line.
 122
 123 #### Website ####
 124
 125    * [Code](https://bugs.debian.org/debbugs-source/debbugs.git/)
 126    * [Debbugs Team](https://wiki.debian.org/Teams/Debbugs|Debbugs Team)
 127
 128 ### Copyright and Lack-of-Warranty Notice ###
 129
 130  * Copyright 1999 Darren O. Benham
 131  * Copyright 1994-1997 Ian Jackson
 132  * Copyright 1997,2003 nCipher Corporation Limited
 133
 134 This bug system is free software; you can redistribute it and/or modify it
 135 under the terms of the GNU General Public License as published by the Free
 136 Software Foundation; version 2 of the License.
 137
 138 This program and documentation is distributed in the hope that it will be
 139 useful, but without any warranty; without even the implied warranty of
 140 merchantability or fitness for a particular purpose. See the GNU General
 141 Public License for more details.
 142
 143 You should have received a copy of the GNU General Public License along
 144 with this program, or one should be available above; if not, write to the
 145 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 146 02111-1307, USA.