| 831 |
florian |
1 |
Phorum SVN Rules
|
|
|
2 |
================
|
|
|
3 |
|
|
|
4 |
This is the first file you should be reading after you get your SVN account.
|
|
|
5 |
We'll assume you're basically familiar with SVN, but feel free to post
|
|
|
6 |
your questions in the development forum at phorum.org.
|
|
|
7 |
|
|
|
8 |
For information on Phorum's SVN repository, please visit our website:
|
|
|
9 |
http://phorum.org/cgi-bin/trac.cgi/wiki/SVNPage
|
|
|
10 |
|
|
|
11 |
Collaboration is a Good Thing(tm), and SVN lets us do this. Thus, following
|
|
|
12 |
some basic rules with regards to SVN usage will:
|
|
|
13 |
|
|
|
14 |
a. Make everybody happier, especially those responsible for maintaining
|
|
|
15 |
the SVN itself.
|
|
|
16 |
b. Keep the changes consistently well documented and easily trackable.
|
|
|
17 |
c. Prevent some of those 'Oops' moments.
|
|
|
18 |
d. Increase the general level of good will on planet Earth.
|
|
|
19 |
|
|
|
20 |
|
|
|
21 |
Having said that, here are the organizational rules:
|
|
|
22 |
|
|
|
23 |
1. Respect other people working on the project.
|
|
|
24 |
|
|
|
25 |
2. Discuss any significant changes on the list or forum before committing.
|
|
|
26 |
|
|
|
27 |
3. If you "strongly disagree" about something another person did, don't
|
|
|
28 |
start fighting publicly - take it up in private email.
|
|
|
29 |
|
|
|
30 |
4. If you don't know how to do something, ask first!
|
|
|
31 |
|
|
|
32 |
5. Test your changes before committing them. We mean it. Really.
|
|
|
33 |
|
|
|
34 |
6. Brian and/or Thomas have the final say.
|
|
|
35 |
|
|
|
36 |
The next few rules are more of a technical nature.
|
|
|
37 |
|
|
|
38 |
1. DO NOT TOUCH ChangeLog! It is automagically updated from the commit
|
|
|
39 |
messages every day. Woe be to those who attempt to mess with it.
|
|
|
40 |
|
|
|
41 |
2. Do not commit multiple file and dump all messages in one commit. If you
|
|
|
42 |
modified several unrelated files, commit each group separately and
|
|
|
43 |
provide a nice commit message for each one. See example below.
|
|
|
44 |
|
|
|
45 |
3. Do write your commit message in such a way that it makes sense even
|
|
|
46 |
without the corresponding diff. One should be able to look at it, and
|
|
|
47 |
immediately know what was modified. Definitely include the function name
|
|
|
48 |
in the message as shown below.
|
|
|
49 |
|
|
|
50 |
4. In your commit messages, keep each line shorter than 80 characters. And
|
|
|
51 |
try to align your lines vertically, if they wrap. It looks bad otherwise.
|
|
|
52 |
|
|
|
53 |
|
|
|
54 |
The format of the commit messages is pretty simple.
|
|
|
55 |
|
|
|
56 |
If a line begins with #, it is taken to be a comment and will not appear
|
|
|
57 |
in the ChangeLog. Everything else goes into the ChangeLog.
|
|
|
58 |
|
|
|
59 |
It is important to note that if your comment logline spans multiple
|
|
|
60 |
lines, you have to put # at the beginning of _every_ such line.
|
|
|
61 |
|
|
|
62 |
Another special prefix is MFB. If you are commiting something to a branch
|
|
|
63 |
and to trunk, plese put MFB on the front of the trunk commit. This will
|
|
|
64 |
keep the log line from showing up twice in the changelog.
|
|
|
65 |
|
|
|
66 |
Example. Say you modified two files, functions.php and mysql.php.
|
|
|
67 |
In functions.php you added a new formatting-function and in mysql.php you
|
|
|
68 |
fixed a bug in a query. Don't commit both of these at once. Commit them
|
|
|
69 |
separately and try to make sure your commit messages look something like
|
|
|
70 |
the following.
|
|
|
71 |
|
|
|
72 |
For functions.php:
|
|
|
73 |
|
|
|
74 |
Added new formatting-function that will print everything bold if the user is
|
|
|
75 |
not wanted
|
|
|
76 |
|
|
|
77 |
For mysql.php:
|
|
|
78 |
Fixed query which messed up the read-page.
|
|
|
79 |
# Man, that query was in there since the stone-age!
|
|
|
80 |
|
|
|
81 |
The # lines will be omitted from the ChangeLog.
|
|
|
82 |
|
|
|
83 |
If you fix some bugs, you should note the ticket ID numbers in your
|
|
|
84 |
commit message. Ticket ID should be prefixed by "#" for easier access to
|
|
|
85 |
tickets when developers are browsing Trac.
|
|
|
86 |
|
|
|
87 |
Example:
|
|
|
88 |
|
|
|
89 |
Fixed attachments-problem when logged in. Ticket #14016
|
|
|
90 |
|
|
|
91 |
To receive daily updates of commits, ask one of the devs to add you to
|
|
|
92 |
the list.
|
|
|
93 |
|
|
|
94 |
Happy hacking,
|
|
|
95 |
|
|
|
96 |
The Phorum Dev Team
|
|
|
97 |
|
|
|
98 |
|
|
|
99 |
* large parts of this file were copied from the PHP Dev Team's
|
|
|
100 |
* CVS-RULES file. Thanks guys.
|
|
|
101 |
|