Menu
▾
▴
[Todo-manager-cvs] todo-manager/docs dev_patch.html,NONE,1.1 index.html,1.12,1.13
|
From: <cl...@us...> - 2002-11-14 06:04:13
|
Update of /cvsroot/todo-manager/todo-manager/docs
In directory usw-pr-cvs1:/tmp/cvs-serv31947
Modified Files:
index.html
Added Files:
dev_patch.html
Log Message:
Documentation on how to write a patch
--- NEW FILE: dev_patch.html ---
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
<html>
<head>
<title>Writing a Patch - ToDo Manager Documentation</title>
<style type="text/css">
<!--
-->
</style>
</head>
<body bgcolor="#FFFFFF" text="#000000" link="#0000C0" vlink="#0000C0">
<center><font face="courier new" size="5" color="darkred"><b>ToDo Manager Documentation</b></font></center>
<hr />
<font face="courier new" size="5"><b>Writing a Patch</b></font>
<hr size="1" />
<p>
<font face="courier new" size="4"><b>Getting Started</b></font><br />
First, it is recommended that you use a very recent CVS nightly build or get
the code straight from CVS. There are two reasons for this:
</p>
<ul>
<li>The bug you are attempting to fix or the feature you plan to add may
already be in CVS, but just wasn't in the last stable release.</li>
<li>Large portions of code can change greatly over a short period of time.</li>
</ul>
<p>
<font face="courier new" size="4"><b>Coding Style</b></font><br />
Patches are more likely to be accepted if they are in the same format and
style as the rest of the code in the project. I won't purposefully reject a
patch if it's coding style doesn't match the projects, but It definitely
makes it easier on the developers when it does.
</p>
<ul>
<li>
Most variables should be in lowercase and use underscores (_) to separate
words. Variables that reference interface elements (Buttons, Textboxes, ...)
should capitalize every word after the first word (e.x. textBoxEelement).
<br /><br />
</li>
<li>
Use tabs not spaces. This is simply a preference of mine. I find that tabs
in source code are easier to deal with than spaces are.
<br /><br />
</li>
<li>
Try to keep the maximum line width to 104 characters (using a tab-width of 8).
Lines that need to be broken up into multiple lines should only be indented
once under their parent line.
<br /><br />
e.x. <code>x = get_value(1,<br /> really_long_function_name(c))</code>
<br /><br />
</li>
</ul>
<p>
<font face="courier new" size="4"><b>Patch Format</b></font><br />
All patches should be generated from the root ToDo Manager source directory.
If possible, the patch should be in the unified format. This can be
accomplished with CVS by executing the following command:
<br /><br />
<code>cvs diff -u > patchfile.diff</code>
<br /><br />
You should consult the documentaion for any other software that you may use
to generate the patch.
<p>
<font face="courier new" size="4"><b>Submitting the Patch</b></font><br />
Once the patch is completed you may submit it to the patch tracker at
<a href="http://sourceforge.net/projects/todo-manager">http://sourceforge.net/projects/todo-manager</a>.
Or you may email it as an attachment to
<a href="mailto:cl...@so...">cl...@so...</a>.
</p>
<hr />
<a href="http://todo-manager.sourceforge.net">todo-manager.sourceforge.net</a>
</body>
</html>
Index: index.html
===================================================================
RCS file: /cvsroot/todo-manager/todo-manager/docs/index.html,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -d -r1.12 -r1.13
--- index.html 17 Sep 2002 05:57:28 -0000 1.12
+++ index.html 14 Nov 2002 06:04:10 -0000 1.13
@@ -30,8 +30,8 @@
<td align="left" valign="top">
<u><b>Developer Documentation</b></u>
<ul>
- <li><u>General Information for Developers</u> (Read This First)</li>
- <li><u>Writing a Patch</u></li>
+ <!-- <li><u>General Information for Developers</u> (Read This First)</li> -->
+ <li><a href="dev_patch.html"><u>Writing a Patch</u></a></li>
<li><u>Using ObjectListbox</u></li>
<li><u>Creating Interfaces</u></li>
</ul>
|
