]> git.ipfire.org Git - thirdparty/freeswitch.git/commitdiff
Document our deviations from commit guidelines
authorTravis Cross <tc@traviscross.com>
Thu, 18 Sep 2014 19:47:36 +0000 (19:47 +0000)
committerTravis Cross <tc@traviscross.com>
Thu, 18 Sep 2014 19:48:25 +0000 (19:48 +0000)
docs/SubmittingPatches

index 58f2467731e8915f156ab3334acf4dc56691599b..4aa8dcdff76fab0c72f8c1e203d15872b987409d 100644 (file)
@@ -129,6 +129,23 @@ If you believe your patch resolves the issue in question, follow the
 issue number with a space and the "--resolve" directive as in the
 example above.
 
+Do As We Say...
+---------------
+
+When you look in our git history, you'll find not all commits follow
+the guidelines here.  Don't be fooled by this.  These guidelines are
+what we want, and your commits should follow them.
+
+It's always difficult to counsel, "do as we say and not as we do," but
+the truth is that the format of your commits will be held to a
+different standard than the commits of people who have written the
+majority of the code in FS.  For one thing, your commits will be
+reviewed, so following a careful format helps us to review and merge
+your patches quickly and efficiently.
+
+We want a clean and sensible git history, and over time more
+contributors will be following the guidelines here.
+
 Where to Go for Help
 --------------------