HACKING

   1                                                                 -*-text-*-
   2
   3                       ===========================
   4                        Hacker's Guide To cvs2svn
   5                       ===========================
   6
   7 This project uses the same social and technical guidelines (where
   8 applicable) as Subversion itself.  You can view them online at
   9 http://svn.collab.net/repos/svn/trunk/www/hacking.html.
  10
  11 Also:
  12
  13    - Read design-notes.txt, you won't regret it.
  14    - Read the class documentation in cvs2svn.
  15    - Please put a new test in run-tests.py when you fix a bug.
  16    - Use 2 spaces between sentences in comments and docstrings.
  17      (This helps sentence-motion commands in some editors.)
  18
  19 Happy hacking!
  20
  21
  22 Making releases
  23 ===============
  24
  25  Pre-release (repeat as appropriate):
  26    A. Backport changes if appropriate.
  27    B. Update CHANGES.
  28    C. Run the testsuite, check everything is OK.
  29    D. Trial-run ./dist.sh, check the output is sane.
  30
  31  Creating the release:
  32    1. If this is an A.B.0 release, make a branch:
  33         svn copy http://cvs2svn.tigris.org/svn/cvs2svn/trunk \
  34           http://cvs2svn.tigris.org/svn/cvs2svn/branches/A.B.x
  35       and then increment the -dev VERSION in cvs2svn on trunk.
  36    2. Switch to a branch working copy.
  37    3. Set VERSION in cvs2svn and then run:
  38         svn copy . http://cvs2svn.tigris.org/svn/cvs2svn/tags/A.B.C
  39    4. Increment the -dev VERSION in cvs2svn on the A.B.x branch.
  40    5. Switch to the tag.
  41    6. Run:
  42         ./dist.sh
  43
  44  Publishing the release:
  45    7. Upload tarball to website download area.
  46    8. Move old releases into the 'Old' folder of the download area.
  47    9. Create a project announcement on the website.
  48   10. Send an announcement to announce@cvs2svn.tigris.org.
  49
  50
  51 Release announcement templates
  52 ==============================
  53
  54 Here are suggested release announcement templates.  Fill in the substitutions
  55 as appropriate, and refer to previous announcements for examples.
  56
  57 Web:
  58 [[[
  59 cvs2svn $VERSION is now released.
  60 The MD5 checksum is $CHECKSUM.
  61 <br />
  62 $BRIEF_DESCRIPTION
  63 <br />
  64 It is available from <a href="$URL"
  65 >$URL</a>.
  66 ]]]
  67
  68 Email:
  69 [[[
  70 Subject: cvs2svn $VERSION released
  71 To: announce@cvs2svn.tigris.org
  72 Reply-to: users@cvs2svn.tigris.org
  73
  74 cvs2svn $VERSION is released.
  75
  76 You can get it here:
  77 $URL
  78 MD5 checksum: $CHECKSUM
  79
  80 $BRIEF_DESCRIPTION
  81
  82 Please send any bug reports and comments to users@cvs2svn.tigris.org.
  83
  84 $YOUR_NAME, on behalf of the cvs2svn development team
  85 ]]]
  86