The overall review process for publication of YANG models by a Broadband Forum Work Area is as follows:
- Each Working Text which defines YANG models must go through a formal group review before publication
- YANG Advisors are to review updates to the YANG models during the development stage. This can be done by reviewing the related pull requests that are issued on the develop branch. The yang-advisors have been added as default reviewers to all YANG pull requests
- At least one advisor is required to approve any YANG related pull request before merging
- The reviewing advisor must not be a contributor to the pull request
- Once the Work Area considers the work to be sufficiently stable, a meeting will be held to agree to proceed to Straw Ballot. At this point, a dedicated release branch will be made for the Straw Ballot version of the YANG models.
- The Work Area Director sends an email on the YANG Advisors mailing list (yang-advisors@broadband-forum.org), triggering the start of the formal review.
- As part of the formal review by the YANG Advisors, the following process applies:
- The review must be done by at least 2 advisors from two different companies, whose comments are aligned and consolidated prior to submission as Straw Ballot comments
- A group member who is responsible for a review must not also be an editor of the WT under review
- The Common YANG Work Area Directors will create tasks in the YANGADV project. The tasks cover the associated pull requests that need to be reviewed. YANG Advisors will then be assigned to these tasks
- The YANG Advisors must check the YANG models for consistency and adherence to OD-360 (to the extend where such checks are not yet automated via tooling)
- The YANG Advisors must check for proper structure, YANG modeling, etc. to ensure future proofing
- The YANG Advisors must ensure consistency in the YANG models defined within a Work Area as well as across Work Areas
- The YANG Advisors must check the YANG models for consistency with other YANG models defined in other Standards Development Organizations (e.g. IETF, IEEE, ITU-T, MEF,...)
- The YANG Advisors will provide a single set of consolidated comments using the standard Straw Ballot comments template: https://issues.broadband-forum.org/browse/CONTRIB-22300
It should be noted that the yang-advisors mailing list can also be used to ask general YANG related questions.