0
Commit Graph

17 Commits

Author SHA1 Message Date
Darik Harter
d48b0323b6 Fix typo in commit_checklist.md
Bug: None
Change-Id: Ib6b20ddf9345217295db25f5dc3a229a399af6a2
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2809640
Reviewed-by: Toby Huang <tobyhuang@chromium.org>
Commit-Queue: Toby Huang <tobyhuang@chromium.org>
Cr-Commit-Position: refs/heads/master@{#870218}
2021-04-07 21:47:04 +00:00
Toby Huang
d358873fd7 Doc: Add tips about git new-branch --upstream_current and git cl issue
This CL adds tips about `git new-branch --upstream_current` and `git
cl issue` to commit_checklist.md. This CL also adds some tips about
testing.

Bug: None
Change-Id: I446ba3fd4997058fd26ae032013cd470cc1ee0fa
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2796214
Auto-Submit: Toby Huang <tobyhuang@chromium.org>
Reviewed-by: Zork <zork@chromium.org>
Commit-Queue: Zork <zork@chromium.org>
Cr-Commit-Position: refs/heads/master@{#868688}
2021-04-01 21:47:34 +00:00
Daniel Libby
12af6b222a Add guidance for git cl upload -T
This option was added a while back, thought it would be useful
to have it called out in the section about patchset titles and
prompting.

Change-Id: I1bb2878d697393dfef493edeb3fcd6984c68b049
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2798018
Commit-Queue: Daniel Libby <dlibby@microsoft.com>
Auto-Submit: Daniel Libby <dlibby@microsoft.com>
Reviewed-by: Toby Huang <tobyhuang@chromium.org>
Cr-Commit-Position: refs/heads/master@{#868318}
2021-03-31 23:30:39 +00:00
Howard Wolosky
7c06f7fa6c [Doc] Update Commit Checklist to call out the need to press Start Review
I missed the fact that you need to explicitly press the "Start Review"
button with one of my recent CL's.  I figure that there are other new
Chromium contributors who may have a similar experience -- so, updating
the checklist to explicitly call this out.

Change-Id: I96a9b97df38bd876b28bf5dc5c493baaf0f561fe
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2636685
Commit-Queue: Howard Wolosky <Howard.Wolosky@microsoft.com>
Reviewed-by: Toby Huang <tobyhuang@chromium.org>
Cr-Commit-Position: refs/heads/master@{#845249}
2021-01-20 18:37:35 +00:00
Toby Huang
b54e133214 [Doc] Add reminder to test edge cases to commit_checklist.md
Under step  for manual testing. The developer doesn't have to test
these edge cases every time, but this bullet is a useful reminder to
think about what unexpected situations could break your code.

Bug: 1142952
Change-Id: Ie5cf5878bc555582e7ea0f8bdf425872b01e834f
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2506066
Reviewed-by: Zork <zork@chromium.org>
Commit-Queue: Zork <zork@chromium.org>
Auto-Submit: Toby Huang <tobyhuang@chromium.org>
Cr-Commit-Position: refs/heads/master@{#822279}
2020-10-29 18:38:02 +00:00
Toby Huang
fb65000a26 [Doc] Add tip about running gclient sync after git rebase-update
This CL modifies commit_checklist.md to add a reminder to run gclient
sync -D after calling git rebase-update. Doing this removes third-
party build errors when trying to re-build after a rebase. This CL
also adds a tip about reverting CLs.

Bug: None
Change-Id: Id6a8072620a1162fbcdbe76b7f365b938287a785
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2450698
Commit-Queue: Toby Huang <tobyhuang@chromium.org>
Reviewed-by: Michael Giuffrida <michaelpg@chromium.org>
Auto-Submit: Toby Huang <tobyhuang@chromium.org>
Cr-Commit-Position: refs/heads/master@{#814822}
2020-10-07 19:59:33 +00:00
Toby Huang
fb6382653e [Doc] Add tip about build, hashtags and not using blanket stamps
This CL adds four miscellaneous tips to commit_checklist.md. Firstly,
use CL hashtags to group related CLs together. Secondly, don't use
chrome/OWNERS as a blanket stamp to land your CL if your CL makes
significant changes to subsystems. Thirdly, this CL adds a link to
instructions for building various targets. Fourthly, this CL adds a
tip about auto-submit.

Bug: None
Change-Id: Iaa3c51b8e2b4a49947061762f3a080a858f41fdd
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2369619
Commit-Queue: Toby Huang <tobyhuang@chromium.org>
Reviewed-by: Michael Giuffrida <michaelpg@chromium.org>
Cr-Commit-Position: refs/heads/master@{#809018}
2020-09-21 20:11:00 +00:00
Toby Huang
2c40fc5a1f Add comment about fixing merge conflicts
When working with downstream branches chained to upstream branches, it
helps to use `git rebase -i @{u}` twice to pull upstream changes into
the downstream branch. Expect a lot of merge conflicts when you do
this, as git is often not smart enough to figure out which change
happened more recently, and should take precedence.

Bug: None
Change-Id: Ic742439981d6d63e8d6bd1e10776fa920c88eb7f
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2341387
Reviewed-by: Michael Giuffrida <michaelpg@chromium.org>
Commit-Queue: Toby Huang <tobyhuang@chromium.org>
Cr-Commit-Position: refs/heads/master@{#796561}
2020-08-10 21:44:40 +00:00
Toby Huang
c9bd85b186 [Documentation change] Modify commit_checklist.md
This CL adds tips about running try jobs and providing patchset titles
to commit_checklist.md.

Bug: None
Change-Id: I25ce9742b7b4f60fd165525cbf2baf5d06dcfa59
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2321835
Commit-Queue: Toby Huang <tobyhuang@chromium.org>
Reviewed-by: Michael Giuffrida <michaelpg@chromium.org>
Cr-Commit-Position: refs/heads/master@{#793376}
2020-07-30 22:02:35 +00:00
Toby Huang
acb9bebae0 [Documentation change] Add more tips to commit_checklist.md
Added a reminder to switch to the correct branch and to rebase any
changes from the upstream branch before resuming development work.

Bug: None
Change-Id: I7828562118825feab8b4a8d322f31bca17f77070
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2262119
Commit-Queue: Toby Huang <tobyhuang@chromium.org>
Reviewed-by: Aga Wronska <agawronska@chromium.org>
Cr-Commit-Position: refs/heads/master@{#782617}
2020-06-25 20:08:04 +00:00
Toby Huang
0a0375c5bc Documentation-only: respond to Mark's comments on commit_checklist.md
This CL responds to Mark Goldstein's comments on commit_checklist.md.
Mark Goldstein was my instructor for the Technical Writing One course,
and as a follow-up exercise, he asked us to include him as a reviewer
on a documentation-related change. This doc will also form the basis
of my upcoming talk "Life of a CL" at Chrome University, so I want to
make sure it's in tip-top form!

Bug: None
Change-Id: I0aeefcbb149929969f15d375f55ea2d2d44684f5
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2045051
Reviewed-by: Aga Wronska <agawronska@chromium.org>
Commit-Queue: Toby Huang <tobyhuang@chromium.org>
Cr-Commit-Position: refs/heads/master@{#743465}
2020-02-21 08:00:28 +00:00
Toby Huang
30496d0045 Documentation-only change to commit_checklist.md about @{u} tip in git
Add tip about @{u} as short-hand for the upstream branch when trying
to squash commits using `git rebase -i @{u}`.

Bug: None
Change-Id: I8b06ccdb976fdfe84eac858d3871fac8f85c2f74
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1993498
Reviewed-by: Aga Wronska <agawronska@chromium.org>
Commit-Queue: Toby Huang <tobyhuang@chromium.org>
Cr-Commit-Position: refs/heads/master@{#729862}
2020-01-09 19:45:24 +00:00
Toby Huang
5c3c00eaf9 Add steps for crbug management to commit_checklist.md documentation
Add reminders to mark the crbug as "started" before starting
development work and to mark the crbug as "fixed" after landing the
CL.

Bug: None
Change-Id: Id79ff0843679c368773b10d22ea9d72e4b1691d2
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1891730
Reviewed-by: Aga Wronska <agawronska@chromium.org>
Commit-Queue: Toby Huang <tobyhuang@chromium.org>
Cr-Commit-Position: refs/heads/master@{#711042}
2019-10-30 23:29:05 +00:00
Toby Huang
e43e5d684d Define intended audience for commit_checklist.md documentation
I added a sentence defining the intended audience for the "Commit
Checklist for Chromium Workflow" documentation.

Bug: None
Change-Id: Ia2f48d4120e99735c6370c864c52f0b89f6d1feb
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1846396
Reviewed-by: Michael Giuffrida <michaelpg@chromium.org>
Commit-Queue: Toby Huang <tobyhuang@chromium.org>
Cr-Commit-Position: refs/heads/master@{#703893}
2019-10-08 21:26:07 +00:00
Toby Huang
242a9f54c4 Edit commit_checklist.md to add tip for Nooglers switching from svn.
Bug: None
Change-Id: I9cabd2e8f87879d4dfbaa1178917fa767008c693
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1802016
Reviewed-by: Aga Wronska <agawronska@chromium.org>
Commit-Queue: Toby Huang <tobyhuang@chromium.org>
Cr-Commit-Position: refs/heads/master@{#696242}
2019-09-13 00:23:23 +00:00
Toby Huang
ba5bbb4624 Add step describing how to squash commits to commit_checklist.md
Add step in commit_checklist.md for squashing commits into a single
commit on the local branch before running `git rebase-update` to avoid
commit-by-commit merge conflicts.

Bug: None
Change-Id: Icccf48d6fe739a3f20f8dd3f7d101ecdad46e3a4
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1784162
Commit-Queue: Toby Huang <tobyhuang@chromium.org>
Reviewed-by: Aga Wronska <agawronska@chromium.org>
Cr-Commit-Position: refs/heads/master@{#693427}
2019-09-04 23:23:07 +00:00
Toby Huang
5105f81d0b Add Chromium commit checklist to contributing.md
R=agawronska

Bug: None
Change-Id: Ic6ab4fd47ffbe272252a350e133d383d386a911e
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1723301
Commit-Queue: Toby Huang <tobyhuang@chromium.org>
Reviewed-by: Aga Wronska <agawronska@chromium.org>
Reviewed-by: Michael Giuffrida <michaelpg@chromium.org>
Cr-Commit-Position: refs/heads/master@{#685403}
2019-08-08 23:47:57 +00:00