README file for Bougie
======================

This file contains information on how to develop for Bougie or submit
a patch to his author.

Submitting a patch
------------------

There are basically two ways to submit a patch to Bougie:

  1) You use GNU Arch (http://www.gnuarch.org/). Since Bougie is maintained
     using GNU Arch on a public repository (see more information on
     http://www.rfc1149.net/devel/bougie), the simplest way for you to
     develop on Bougie is to branch your own repository. When you want
     some of your changes integrated into the mainstream repository, send
     a mail with your repository location and changes numbers to
     "Samuel Tardieu <sam@rfc1149.net>".

  2) You don't use GNU Arch. In this case, you can send context diffs (-c)
     or unidiff patches (-u) to "Samuel Tardieu <sam@rfc1149.net>". Please
     indicate from which version of Bougie we started.

In both cases, I prefer that you sign your patches using GnuPG (this is
an option starting with GNU Arch 1.2). The development version of Bougie
is signed with key:

  1024D/A510724B 2003-12-30
    Samuel Tardieu (software signing key only) <sam@rfc1149.net>
  Key fingerprint = E21A 70D3 1D70 97D1 4D72  40DA A288 537E A510 724B

Style information
-----------------

Please use the following guidelines when coding for Bougie:

  - use spaces before opening parenthesis: foo (bar)
  - use only the "sre" module for regular expressions ("re" is only a wrapper)
  - write punctuated __doc__ strings for every functions (multilines strings
    after the function declaration)
