svn commit: r1851490 - /calcite/site/develop/index.html

[se...@apache.org]

Author: sereda
Date: Wed Jan 16 22:35:15 2019
New Revision: 1851490

URL: http://svn.apache.org/viewvc?rev=1851490&view=rev
Log:
Update single file 'develop/index.html' from 73f71095e

Modified:
    calcite/site/develop/index.html

Modified: calcite/site/develop/index.html
URL: http://svn.apache.org/viewvc/calcite/site/develop/index.html?rev=1851490&r1=1851489&r2=1851490&view=diff
==============================================================================
--- calcite/site/develop/index.html (original)
+++ calcite/site/develop/index.html Wed Jan 16 22:35:15 2019
@@ -149,6 +149,29 @@ the JIRA case number, like this:</p>
 squash them into a single commit, and to bring your code up to date
 with the latest on the main line.</p>
 
+<p>In order to keep the commit history clean and uniform, you should 
+respect the following guidelines.</p>
+<ul>
+  <li>Read the messages of previous commits, and follow their style.</li>
+  <li>The first line of the commit message must be a concise and useful
+description of the change.</li>
+  <li>The message is often, but not always, the same as the JIRA subject.
+If the JIRA subject is not clear, change it (perhaps move the original
+subject to the description of the JIRA case, if it clarifies).</li>
+  <li>Start with a capital letter.</li>
+  <li>Do not finish with a period.</li>
+  <li>Use imperative mood (“Add a handler …”) rather than past tense
+(“Added a handler …”) or present tense (“Adds a handler …”).</li>
+  <li>If possible, describe the user-visible behavior that you changed
+(“FooCommand now creates directory if it does not exist”), rather than
+the implementation (“Add handler for FileNotFound”).</li>
+  <li>If you are fixing a bug, it is sufficient to describe the bug
+ (“NullPointerException if user is unknown”) and people will correctly
+ surmise that the purpose of your change is to fix the bug.</li>
+  <li>If you are not a committer, add your name in parentheses at the end
+ of the message.</li>
+</ul>
+
 <p>Then push your commit(s) to GitHub, and create a pull request from
 your branch to the calcite master branch. Update the JIRA case
 to reference your pull request, and a committer will review your