Github user hmcl commented on the issue:

    https://github.com/apache/storm/pull/2550
  
    @erikdw I agree that in this case where we are cherry-picking several 
commits it's very hard to avoid multiple commits, and probably we shouldn't 
even try to squash them because that will completely erase historical context 
and where things came from. Nevertheless, I would like to suggest that the all 
commit messages for this PR follow the convention[1] 
    
    ```
    STORM-2937: Overwrite storm-kafka-client 1.x-branch into 1.0.x-branch
     - Message which ideally should contain the message and SHA of the commit 
that was cherry-picked. IntelliJ, and git cherry-pick typically do that by 
default
    ``` 
    
    Currently git log for this PR (truncated to be easy to read here) looks 
like this:
    
    ```
    ad7360507 add storm-kafka-client doc from 1.x-branch, and link to it from 
index.md
    0ddc41154 copy Time.java from 1.x-branch to allow use of nanoTime() in 
storm-kafka-client
    5d9ad1eaa backport changes to Fields to allow it to be checked for equality 
in storm-kafka-client 
    f758123b5 backport trident interface changes
    e42ae4de8 update storm-kafka-client pom.xml and base pom.xml as necessary 
for using storm-
    533ef7ad2 copied external/storm-kafka-client from 1.x-branch at SHA 74ca795 
(this doesn't
    9c8930036 Merge branch 'STORM-2918-1.0.x-merge' into 1.0.x-branch
    4df41444b STORM-2918 Update Netty version
    5b507eaf0 Merge branch 'STORM-2853-1.0.x-merge' into 1.0.x-branch
    4841475a7 STORM-2853 Initialize tick tuple after initializing spouts/bolts
    ```
    
    I think that it would be much easier to trace back the bulk change if the 
git log was something like:
    
    ```
    ad7360507 STORM-2937: Overwrite storm-kafka-client 1.x-branch into 
1.0.x-branch
    0ddc41154 STORM-2937: Overwrite storm-kafka-client 1.x-branch into 
1.0.x-branch
    5d9ad1eaa STORM-2937: Overwrite storm-kafka-client 1.x-branch into 
1.0.x-branch
    f758123b5 STORM-2937: Overwrite storm-kafka-client 1.x-branch into 
1.0.x-branch
    e42ae4de8 STORM-2937: Overwrite storm-kafka-client 1.x-branch into 
1.0.x-branch
    533ef7ad2 STORM-2937: Overwrite storm-kafka-client 1.x-branch into 
1.0.x-branch
    9c8930036 Merge branch 'STORM-2918-1.0.x-merge' into 1.0.x-branch
    4df41444b STORM-2918 Update Netty version
    5b507eaf0 Merge branch 'STORM-2853-1.0.x-merge' into 1.0.x-branch
    4841475a7 STORM-2853 Initialize tick tuple after initializing spouts/bolts
    ```
    
    And, for instance, for SHA ad7360507 the message would be.
    
    ```
    STORM-2937: Overwrite storm-kafka-client 1.x-branch into 1.0.x-branch
     - add storm-kafka-client doc from 1.x-branch, and link to it from index.md
          (cherry picked from commit SHA) - this would be optional if its a big 
pain, but I think git does it for you
    ``` 
    
    Similarly for the other SHAs.
    
    [1] - I don't necessarily mean Storm convention


---

Reply via email to