encounter
/
dawn-cmake
mirror of https://github.com/encounter/dawn-cmake.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs/contributing.md: Explain how to start a review. 

Also mention that the Bug: tag should be at the bottom of the commit
message.

Bug: dawn:23
Change-Id: Ib4e6b3c3db2f97af94c7e8240af90f85add5547f
Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/52780
Auto-Submit: Corentin Wallez <cwallez@chromium.org>
Commit-Queue: Austin Eng <enga@chromium.org>
Reviewed-by: Austin Eng <enga@chromium.org>
This commit is contained in:
Corentin Wallez 2021-06-01 16:08:22 +00:00 committed by Dawn LUCI CQ
parent e98979415e
commit ac61042f8b
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/contributing.md
View File

@ -79,6 +79,12 @@ Pushing commits is done with `git push origin HEAD:refs/for/main`. Which means
push to `origin` (i.e. Gerrit) the currently checkout out commit to the push to `origin` (i.e. Gerrit) the currently checkout out commit to the
`refs/for/main` magic branch that creates or updates CLs. `refs/for/main` magic branch that creates or updates CLs.
In the terminal you will see a URL where code review for this CL will happen.
CLs start in the "Work In Progress" state. To start the code review proper,
click on "Start Review", add reviewers and click "Send and start review". If
you are unsure which reviewers to use, pick one of the reviewers in the
[OWNERS file](../OWNERS) who will review or triage the CL.
When code review asks for changes in the commits, you can amend them any way When code review asks for changes in the commits, you can amend them any way
you want (small fixup commit and `git rebase -i` are crowd favorites) and run you want (small fixup commit and `git rebase -i` are crowd favorites) and run
the same `git push origin HEAD:refs/for/main` command. the same `git push origin HEAD:refs/for/main` command.
@ -87,9 +93,9 @@ the same `git push origin HEAD:refs/for/main` command.
We usually like to have commits associated with issues in [Dawn's issue tracker](https://bugs.chromium.org/p/dawn/issues/list) We usually like to have commits associated with issues in [Dawn's issue tracker](https://bugs.chromium.org/p/dawn/issues/list)
so that commits for the issue can all be found on the same page. This is done so that commits for the issue can all be found on the same page. This is done
by adding a `Bug: dawn:<issue number>` tag in the commit message. It is also by adding a `Bug: dawn:<issue number>` tag at the end of the commit message. It
possible to reference Chromium or Tint issues with `Bug: tint:<issue number>` or is also possible to reference Chromium or Tint issues with
`Bug: chromium:<issue number>`. `Bug: tint:<issue number>` or `Bug: chromium:<issue number>`.
Some small fixes (like typo fixes, or some one-off maintenance) don't need a Some small fixes (like typo fixes, or some one-off maintenance) don't need a
tracking issue. When that's the case, it's good practice to call it out by tracking issue. When that's the case, it's good practice to call it out by