DCAE Committer Guidelines
- 1 Review window
- 2 Configure Gerrit watch for auto-notification
- 3 Check the Commit Message:
- 4 Check the License Blocks and Copyright Lines on all code and documentation files
- 5 Check for comments in all new code
- 6 Check the code
- 7 Check whether the version number should be updated
- 8 Check the Build Console Output
- 9 Were there any -1 or -2 on previous patches by another committer or the PTL?
- 10 Self-Release yaml
- 11 ChangeLog.md file
- 12 Vacation Notice
- 13 onap-gerrit-review information
In addition to the guidelines specified Committer Best Practices, all DCAE committers are expected to look at these areas before merging a patch. If any item is not followed, you should reply with a -1. Also add comments in appropriate places within the code.
Many of the following checks have been incorporated into the onap-gerrit-review
tool and will be test**
Review window
Avoid same day approval unless change is fixing an broken job or critical bug.
As committers are spread across different timezone, provide at least a 24 hour window before merging any non-critical updates.
Include other committers (if not already added into review) and primary contributors for reviews.
Configure Gerrit watch for auto-notification
Go to Gerrit→ Settings→Notification to setup auto email alerts to recieve notification on submission into DCAE repository. This will help when submitter miss to add explicitly all the committers for reviews.
Also check the Gerrit dashboard for yourself.
Check the Commit Message:
Is the JIRA ticket issue related to this fix?
Do either the issue or the commitment message properly describe what is being changed and why?
For self-release yaml, ensure comment includes a description of changes/bug fixes introduced in that version. If multiple jira's are consolidated - include all Jira references and a brief summary.
Check the License Blocks and Copyright Lines on all code and documentation files
onap-gerrit-review: Is there a LICENSE.txt file?
onap-gerrit-review: All code modules should have comments at the beginning that look like this, using the appropriate comment convention: