[giimote commit] r199 - Added wiki page on creating and submitting patches
codesite...@google.com
Date: Sat May 9 22:47:11 2009
New Revision: 199
Added:
wiki/CreatingPatches.wiki
Log:
Added wiki page on creating and submitting patches
Added: wiki/CreatingPatches.wiki
==============================================================================
--- (empty file)
+++ wiki/CreatingPatches.wiki Sat May 9 22:47:11 2009
@@ -0,0 +1,34 @@
+#summary Instructions for creating and submitting a subversion patch
+#labels Phase-Implementation
+
+= Introduction =
+
+GiiMote is an open source project and user contributions are welcome in
the form of patches. Patch files are small, portable, ".diff" files which
describe all of the changes the developer has made to the source code (the
*diff*-erences). These files can then be reviewed and checked in to the
repository.
+
+
+= Creating a patch =
+
+To create a patch first [BuildDocumentation download and build] GiiMote.
After you are sure GiiMote compiles correctly make and test your changes.
Once your changes compile correctly, are bug-free, and follow the
appropriate [CodingStyles coding styles] you can navigate to the root
directory of the project and execute the following command to see a list of
all modified files:
+
+{{{
+svn status
+}}}
+
+To create the actual patch file you can then run:
+
+{{{
+svn diff > patch_file.diff
+}}}
+
+Make sure you are in the root directory (not trunk, but the directory
containing it) when you create your diff file and that you give the file a
descriptive name.
+
+
+= Submitting a patch =
+
+Once you've created and tested a patch you can submit it for inclusion in
the main source tree. To do so visit the
[http://code.google.com/p/giimote/issues/list Issues List] and either
attach the path to a relevant issue or create a new issue detailing the bug
fix, feature, or other modification you have made. Please describe the
changes you made to the code in detail in your report and apply the
label "Type-Patch" to your issue. _DO NOT_ copy the contents of your diff
file into the description box, always submit patches as an attachment.
Finally, Cc yourself on the issue and you will be notified when your patch
is accepted or if further modifications are needed.
+
+
+= Links =
+
+ * [http://code.google.com/p/giimote/issues/list Issues List]
+ * [http://svnbook.red-bean.com/en/1.5/svn.ref.svn.c.diff.html svn diff]