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 of cvs2svn
  22     (and perhaps some other branches) at repo.or.cz.  The summary page
  23     is at
  24
  25       http://repo.or.cz/w/cvs2svn.git
  26
  27     and the (read-only) mirror is at
  28
  29       git://repo.or.cz/cvs2svn.git
  30
  31 * Read the files under doc/, especially:
  32
  33   * doc/design-notes.txt gives a high-level description of the
  34     algorithm used by cvs2svn to make sense of the CVS history.
  35
  36   * doc/symbol-notes.txt describes how CVS symbols are handled.
  37
  38   * doc/making-releases.txt describes the procedure for making a new
  39     release of cvs2svn.
  40
  41 * Read the files under www/, especially:
  42
  43   * www/features.html describes abstractly many of the CVS
  44     peculiarities that cvs2svn attempts to deal with.
  45
  46   Please note that changes committed to the trunk version of www/ are
  47   automatically deployed to the cvs2svn project website.
  48
  49 * Read the class and method docstrings.
  50
  51 * Adhere to the code formatting conventions of the rest of the
  52   project (e.g., limit line length to 79 characters).
  53
  54 * We no longer require the exhaustive commit messages required by the
  55   Subversion project.  But please include commit messages that:
  56
  57   * Describe the *reason* for the change.
  58
  59   * Attribute changes to their original author using lines like
  60
  61     Patch by: Joe Schmo <schmo@example.com>
  62
  63 * Please put a new test in run-tests.py when you fix a bug.
  64
  65 * Use 2 spaces between sentences in comments and docstrings.  (This
  66   helps sentence-motion commands in some editors.)
  67
  68
  69 Happy hacking!
  70