3 ===========================
4 Hacker's Guide To cvs2svn
5 ===========================
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.
11 * The source code is accessible from two places:
13 * The primary repository for cvs2svn is held in Subversion under the
16 http://cvs2svn.tigris.org/svn/cvs2svn
18 The repository is readable by anybody using username="guest",
19 password="" (i.e., just press return).
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
25 http://repo.or.cz/w/cvs2svn.git
27 and the (read-only) mirror is at
29 git://repo.or.cz/cvs2svn.git
31 * Read the files under doc/, especially:
33 * doc/design-notes.txt gives a high-level description of the
34 algorithm used by cvs2svn to make sense of the CVS history.
36 * doc/symbol-notes.txt describes how CVS symbols are handled.
38 * doc/making-releases.txt describes the procedure for making a new
41 * Read the files under www/, especially:
43 * www/features.html describes abstractly many of the CVS
44 peculiarities that cvs2svn attempts to deal with.
46 Please note that changes committed to the trunk version of www/ are
47 automatically deployed to the cvs2svn project website.
49 * Read the class and method docstrings.
51 * Adhere to the code formatting conventions of the rest of the
52 project (e.g., limit line length to 79 characters).
54 * We no longer require the exhaustive commit messages required by the
55 Subversion project. But please include commit messages that:
57 * Describe the *reason* for the change.
59 * Attribute changes to their original author using lines like
61 Patch by: Joe Schmo <schmo@example.com>
63 * Please put a new test in run-tests.py when you fix a bug.
65 * Use 2 spaces between sentences in comments and docstrings. (This
66 helps sentence-motion commands in some editors.)