...
- Someone editing a given submodel commits an update to gerrit.
- Only the current model editor should be committing updates unless permission is granted by the current editor for someone else to temporarily be the editor to perform some update.
- A reasonable message is included in the commit, explaining what was updated.
- Given there is only a few characters allowed in the first line of commit, the second line of text should probably be used.
- Generally, a separate commit should be performed for each submodel. An exception to this would be if the multiple models relate as part of some effort (some cross-model contribution).
- IISOMI modeling guidelines must be followed, and reviews must assure that the guidelines are being adhered to before discussion occurs in some working team.
- The committer assigns reviewersOne primary independent reviewer and perhaps a backup reviewer is assigned to perform the +1
- At least two reviewers, but more is fine. Available reviewers are Hui Deng , Xu Yang , guochuyi Kevin Scaggs .
Note: Only one +1 is required, regardless of the number of reviewers assigned - The +1 reviewer cannot be the submodel editor or the editor performing the papyrus commit (if different from the submodel editor). The +1 reviewer cannot be from the same company as the editor performing the commit.
- Reviewers should be familiar with the subject area of the contribution if possible. This suggests they participate on the weekly calls related to the contribution. It is noted that there may be exceptions to this (work on some concept may be "new" to all).
- If another editor has been active in the same domain in recent time, they should be the +1 reviewer. If the commit is broad in scope, adding all the reviewers impacted by the contribution is appropriate.
- The
- committer
- must also supply a gendoc output of the submodel (or the relevant portion of the submodel), supplying it to the reviewers to facilitate easier approval.
- Gendoc output to be placed in Model tools \ Papyrus \ Gendoc Files Related to Gerrit Commits
- Providing such output will allow for quick reviews, and not require the reviewers to attempt to download the committed files into a papyrus environment for review.
- It is assumed that the gendoc output reflects the model / model fragment being updated.
- Reviewers
- Reviews are done with a 'first come, first serve" approach with a couple of exceptions
- The +1 reviewer cannot be from the same company as the editor performing the commit.
- If the editor performing the commit is not the regular submodel editor, the regular editor should perform the +2, verify, and merge.
- The first available reviewer examines the request, including the gendoc output (2b above) as appropriate, and performs the +1.
- The second reviewer (whoever next notices the request) is responsible for performing the +2, verify, and merge.
- Keep in mind that commits are part of a "work in progress", not necessarily a finished work.
- Reviews should be completed quickly to facilitate further development (suggest 24 hours or less).
- For contributions of new material not yet socialized and/or not fully developed, a fairly 'relaxed' review with perhaps some suggestions is very reasonable.
- If a model conflict occurs, the submodel editor decides how to resolve.
Note: In the past, Deng Hui has carried the burden of merging all commits. This proposal will relieve him of that this burden.