1 |
Muddleftpd Developer Guidelines |
Muddleftpd Developer Guidelines |
2 |
|
|
3 |
|
This is: $Revision$. |
4 |
|
|
5 |
[Note before: That text is assembled from different other guidelines I |
[Note before: That text is assembled from different other guidelines I |
6 |
read and some talks I had with other people.] |
read and some talks I had with other people.] |
7 |
|
|
12 |
1.2 CVS Branches |
1.2 CVS Branches |
13 |
1.3 Muddleftpd Releases |
1.3 Muddleftpd Releases |
14 |
1.4 Security Updates, Important Bugfixes |
1.4 Security Updates, Important Bugfixes |
15 |
1.5 Code Submission if you are not a developer of Muddleftpd |
1.5 ChangeLog Entries and CVS commit messages (log messages) |
16 |
1.6 How to become a developer |
1.6 Code Submission if you are not a developer of Muddleftpd |
17 |
|
1.7 How to become a developer |
18 |
|
|
19 |
|
|
20 |
1.0 Copyright issues |
1.0 Copyright issues |
25 |
|
|
26 |
/* FILENAME SHORT DESCRIPTION OF THE FILE |
/* FILENAME SHORT DESCRIPTION OF THE FILE |
27 |
|
|
28 |
Copyright (C) 1999 Beau Kuiper |
Copyright (C) 2002 Muddleftpd Team, http://www.nongnu.org/muddleftpd/ |
29 |
|
|
30 |
This program is free software; you can redistribute it and/or modify |
This program is free software; you can redistribute it and/or modify |
31 |
it under the terms of the GNU General Public License as published by |
it under the terms of the GNU General Public License as published by |
190 |
finished yet (hey, we aim to produce a secure ftp daemon, that needs |
finished yet (hey, we aim to produce a secure ftp daemon, that needs |
191 |
time) but still can react quickly on such bugs. |
time) but still can react quickly on such bugs. |
192 |
|
|
193 |
|
|
194 |
|
1.5 ChangeLog Entries and CVS commit messages (log messages) |
195 |
|
|
196 |
|
First please take a look at the following URL. The text there is really |
197 |
|
good, you should follow it as close as possible: |
198 |
|
http://www.red-bean.com/cvs2cl/changelogs.html |
199 |
|
|
200 |
|
We require that you follow these guidelines while creating your |
201 |
|
ChangeLog entry. Reasons are listed there too, mainly to have a clear |
202 |
|
log of changes that are done to the source. |
203 |
|
|
204 |
|
Talking about messages for cvs commit: |
205 |
|
You can just re-use the logmessage from the ChangeLog for the commit |
206 |
|
message (Emacs CVS Mode does it for you if you use that), thats fine. |
207 |
|
But if you write them by Hand it is enough if you write a clear |
208 |
|
sentence (or many of them) describing your changes to the file(s) you |
209 |
|
commit. For details everyone could look into the ChangeLog. But NEVER |
210 |
|
commit with an empty Message or just a "changed". That way everyone can |
211 |
|
follow the changes you made with the cvs log output and can look into |
212 |
|
the ChangeLog file for a detailed description of the changes. |
213 |
|
|
214 |
|
|
215 |
|
|
216 |
1.5 Code Submission if you are not a developer of Muddleftpd |
1.6 Code Submission if you are not a developer of Muddleftpd |
217 |
|
|
218 |
When you fix a bug or add a feature, you must submit a unified patch |
When you fix a bug or add a feature, you must submit a unified patch |
219 |
(see below for instructions for creating the patch) to the Patch Manager |
(see below for instructions for creating the patch) to the Patch Manager |
251 |
configure scripts. |
configure scripts. |
252 |
|
|
253 |
|
|
254 |
1.6 How to become a developer |
1.7 How to become a developer |
255 |
|
|
256 |
Well, thats not that hard. Of course we require a little knowledge, so |
Well, thats not that hard. Of course we require a little knowledge, so |
257 |
you have to prove you can do the work you say you want to do. |
you have to prove you can do the work you say you want to do. |