Revision: 21d50d248ff3
Author: Petr Pudlak <[email protected]>
Date: Tue Sep 23 16:05:36 2014 UTC
Log: Enhanced the section about submitting patches
https://code.google.com/p/ganeti/source/detail?r=21d50d248ff3&repo=wiki
Modified:
/DeveloperGuidelines.wiki
=======================================
--- /DeveloperGuidelines.wiki Wed May 14 08:04:30 2014 UTC
+++ /DeveloperGuidelines.wiki Tue Sep 23 16:05:36 2014 UTC
@@ -33,6 +33,8 @@
== Preparing patches for submission ==
+=== Checking patches ===
+
If you have more than a trivial fix it's better to make sure that the
static checks are fine before sending the patches. This can be done by
running the command:
{{{
@@ -42,11 +44,43 @@
For this, you need to have `pylint` and `hlint` installed.
The output of these tools can change significantly from one version to the
other, and some errors might happen to be signalled only by some versions,
so we had to standardize on a specific version as the official one Ganeti
has to be validated against. You can find the version number (for Ganeti's
current master branch) at:
http://docs.ganeti.org/ganeti/master/html/devnotes.html
+=== Commit messages ===
+
+Commit messages should be informative and well-worded. Example:
+
+{{{
+Short summary line (60 characters long at most, no period at end)
+
+Detailed explanation if necessary, wrapped at ~72 chars/line. Can also be
in multiple paragraphs.
+If the commit modified more than four lines of code, the explanation is
required and must contain at least 20 characters.
+ * Use itemized list if several things were done in the same patch
+ * But consider doing them in different patches
+}}}
+
+=== Formatting and sending patches ===
+
The patch to send should be a proper patch created by Git and signed by
you. The patch can be created with the following command:
{{{
-git format-patch -s ...
+git format-patch -s --subject-prefix=... ...
}}}
+
+The `-s` options adds the required ''Signed-off-by'' tag to the end of the
patch.
+
+Each patch should have a subject prefix indicating the branch it's
directed to (for ganeti-core) or the separate repository it's for. For
example patches for ganeti-core branch-2.6 should be generated by passing
the option `--subject-prefix="PATCH branch-2.6"` to `git format-patch`.
+
+Officially recognized prefix tags are:
+
+ * *PATCH stable-2.x* for patches directed at ganeti stable-2.x
+ * *PATCH master* for patches directed at the development tree
+ * *PATCH instance-debootstrap* for patches directed at the
ganeti-instance-deboostrap repository
+
+When sending a patch series, it is customary to include cover letter
(`--cover-letter` option).
+
+Also note that you can change `PATCH` to `RFC` if you want to send a
+patch/series just for discussion, rather than to propose its inclusion
right
+away (it's basically an invite for more feedback).
+
== More details on git workflow ==
--
---
You received this message because you are subscribed to the Google Groups "ganeti-commits" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
For more options, visit https://groups.google.com/d/optout.
