You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cassandra.apache.org by be...@apache.org on 2019/08/08 16:01:00 UTC

[cassandra] branch trunk updated: Add more information around commit message format expected for a patch

This is an automated email from the ASF dual-hosted git repository.

benedict pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/cassandra.git


The following commit(s) were added to refs/heads/trunk by this push:
     new 905ed48  Add more information around commit message format expected for a patch
     new bf41319  Merge pull request #338 from sumanth-pasupuleti/15246_trunk
905ed48 is described below

commit 905ed484932688b14f5bfe83e99b14d63094d62b
Author: Sumanth Pasupuleti <su...@gmail.com>
AuthorDate: Thu Aug 8 08:50:42 2019 -0700

    Add more information around commit message format expected for a patch
---
 doc/source/development/patches.rst | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/doc/source/development/patches.rst b/doc/source/development/patches.rst
index 43bdb8c..f3a2cca 100644
--- a/doc/source/development/patches.rst
+++ b/doc/source/development/patches.rst
@@ -108,7 +108,14 @@ So you've finished coding and the great moment arrives: it's time to submit your
    a. Attach a patch to JIRA with a single squashed commit in it (per branch), or
    b. Squash the commits in-place in your branches into one
 
- 6. Include a CHANGES.txt entry (put it at the top of the list), and format the commit message appropriately in your patch ending with the following statement on the last line: ``patch by X; reviewed by Y for CASSANDRA-ZZZZZ``
+ 6. Include a CHANGES.txt entry (put it at the top of the list), and format the commit message appropriately in your patch as below.
+ 
+    ::
+
+      <One sentence description, usually Jira title and CHANGES.txt summary>
+      <Optional lengthier description>
+      patch by <Authors>; reviewed by <Reviewers> for CASSANDRA-#####
+ 
  7. When you're happy with the result, create a patch:
 
    ::


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cassandra.apache.org
For additional commands, e-mail: commits-help@cassandra.apache.org