HACKING

   1                                                                 -*-text-*-
   2
   3                       ===========================
   4                        Hacker's Guide To cvs2svn
   5                       ===========================
   6
   7 This project tends to use the same social and technical guidelines
   8 (where applicable) as Subversion itself.  You can view them online at
   9 http://subversion.apache.org/docs/community-guide/conventions.html.
  10
  11 * The source code is accessible from two places:
  12
  13   * The primary repository for cvs2svn is held in Subversion under the
  14     following URL:
  15
  16       http://cvs2svn.tigris.org/svn/cvs2svn
  17
  18     The repository is readable by anybody using username="guest",
  19     password="" (i.e., just press return).
  20
  21   * Michael Haggerty maintains a Git mirror of the trunk and some
  22     other branches at GitHub:
  23
  24       https://github.com/mhagger/cvs2svn
  25
  26     The branches in this repository are subject to being rebased
  27     and/or rewritten, though I'll try to avoid doing so with "master"
  28     and release branches.
  29
  30     Feel free to fork this repository and push your patches to your
  31     fork, but please *also* email the dev mailing list with any
  32     discussion and a link to the patches.  The mailing list remains
  33     the main forum for discussing changes to cvs2svn.
  34
  35 * Read the files under doc/, especially:
  36
  37   * doc/design-notes.txt gives a high-level description of the
  38     algorithm used by cvs2svn to make sense of the CVS history.
  39
  40   * doc/symbol-notes.txt describes how CVS symbols are handled.
  41
  42   * doc/making-releases.txt describes the procedure for making a new
  43     release of cvs2svn.
  44
  45 * Read the files under www/, especially:
  46
  47   * www/features.html describes abstractly many of the CVS
  48     peculiarities that cvs2svn attempts to deal with.
  49
  50   Please note that changes committed to the trunk version of www/ are
  51   automatically deployed to the cvs2svn project website.
  52
  53 * Read the class and method docstrings.
  54
  55 * Adhere to the code formatting conventions of the rest of the
  56   project (e.g., limit line length to 79 characters).
  57
  58 * We no longer require the exhaustive commit messages required by the
  59   Subversion project.  But please include commit messages that:
  60
  61   * Describe the *reason* for the change.
  62
  63   * Attribute changes to their original author using lines like
  64
  65     Patch by: Joe Schmo <schmo@example.com>
  66
  67 * Please put a new test in run-tests.py when you fix a bug.
  68
  69 * Use 2 spaces between sentences in comments and docstrings.  (This
  70   helps sentence-motion commands in some editors.)
  71
  72
  73 Happy hacking!
  74