From 680645e5020e0839757aa40679a82173192d9638 Mon Sep 17 00:00:00 2001 From: "Bobby R. Bruce" Date: Mon, 27 Jan 2020 15:00:17 -0800 Subject: [PATCH] misc: Updated CONTRIBUTING.md to discuss WIP changes Previously CONTRIBUTING.md discused private changes, but contributors cannot submit private changes to Gerrit under the current configuration. This has therefore been removed and replaced with an explanation of how to submit a WIP (Work In Progress) changes to Gerrit. WIP changes are permitted. Change-Id: I9e1acbdaf4a9b5c433c0704ba9faf325a6b48c6a Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/24805 Reviewed-by: Jason Lowe-Power Reviewed-by: Daniel Carvalho Maintainer: Bobby R. Bruce Tested-by: kokoro --- CONTRIBUTING.md | 33 ++++++++++++++++++++++++--------- 1 file changed, 24 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7b3dcfd9d..2a24f0571 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -276,20 +276,35 @@ changeset. git commit --amend ``` -Push change to gerrit as a draft/private ----------------------------------------- +Push change to gerrit as a Work In Progress +------------------------------------------- -See https://gerrit-review.googlesource.com/Documentation/intro-user.html#private-changes -for details on private gerrit changes. +It is acceptable to push commits as "Work In Progress" (WIP) changes within +gerrit. WIP changes are publicly visible though no one will be able to review +the changes or be directly notified they have been submitted. WIP changes can +be useful for backing up code currently under-development or for sharing +incomplete code with the wider community (i.e., the link to the gerrit change +may be shared, and others may download the change, comment on it, and track +alterations over time). + +See https://gerrit-review.googlesource.com/Documentation/intro-user.html#wip +for details on WIP gerrit changes. + +To push a change as a WIP: ``` - git push origin HEAD:refs/for/develop%private + git push origin HEAD:refs/for/develop%wip ``` -Once you have pushed your change as "private", you can log onto [gerrit] -(https://gem5-review.googlesource.com) and once you're happy with the commit -click the "unmark private" which may be hidden in the "more options" dropdown -in the upper right corner. +Once you have pushed your change as a WIP, you can log onto [gerrit]( +https://gem5-review.googlesource.com) and view it. Once you're happy with the +change you can add reviewers which shall move your change from WIP status +to be considered for submission by the wider gem5 community. Switching from a +WIP to a regular change does not notify the gem5 community, via the gem5-dev +mailing-list, that a change has been submitted (as would occur if a change were +submitted directly for review). It is therefore important to include reviewers +and CC those who you wish to view the change (they will be notified +automatically via email). Push change bypassing gerrit ----------------------------- -- 2.30.2