[
https://issues.apache.org/jira/browse/BEAM-6122?focusedWorklogId=169470&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-169470
]
ASF GitHub Bot logged work on BEAM-6122:
----------------------------------------
Author: ASF GitHub Bot
Created on: 26/Nov/18 20:01
Start Date: 26/Nov/18 20:01
Worklog Time Spent: 10m
Work Description: swegner commented on a change in pull request #7129:
[BEAM-6122] Update committer guidelines
URL: https://github.com/apache/beam/pull/7129#discussion_r236403823
##########
File path: website/src/contribute/committer-guide.md
##########
@@ -77,15 +95,25 @@ At some point in the review process, the change to the
codebase will be
complete. However, the pull request may have a collection of review-related
commits that are not meaningful to preserve in the history. The reviewer should
give the LGTM and then request that the author of the pull request rebase,
-squash, split, etc, the commits, so that the history is most useful. Favor
-commits that do just one thing. The commit is the smallest unit of easy
+squash, split, etc, the commits, so that the history is most useful:
+* Favor commits that do just one thing. The commit is the smallest unit of easy
rollback; it is easy to roll back many commits, or a whole pull request, but
harder to roll back part of a commit.
+* Commit messages should tag JIRAs and be otherwise descriptive.
+It should later not be necessary to find a merge or first PR commit to find
out what caused a change.
Review comment:
FYI, GitHub's UI makes it easy to find the associated PR, which I find to be
most useful as it contains the discussion / metadata around a change.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 169470)
> Update committer guidelines
> ---------------------------
>
> Key: BEAM-6122
> URL: https://issues.apache.org/jira/browse/BEAM-6122
> Project: Beam
> Issue Type: Task
> Components: website
> Reporter: Thomas Weise
> Assignee: Thomas Weise
> Priority: Major
> Time Spent: 50m
> Remaining Estimate: 0h
>
> Per discussion in
> [https://lists.apache.org/thread.html/6d922820d6fc352479f88e5c8737f2c8893ddb706a1e578b50d28948@%3Cdev.beam.apache.org%3E]
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
