4. Pull Requests

Creating, reviewing, and refining docs for publication

A pull request is a collaboration method for contributors to request a review and approval before changes to a documents in a repository become final.

Microsoft Teams

1. Teams has a two-step process for merging changes visible for public viewing
2. A contributor must create a branch from the master to make changes.
3. After a document update or addition has been created, the contributor creates a Pull Request (PR) for review. The changes can be reviewed on the Teams review site. To review, select the branch were the changes have been made from the drop-down menu:

1. If the changes are approved the branch is merged into the master branch
2. If all checks pass, you must create a new PR comparing the master -> live.
3. If all checks pass, you can merge the live sub-branch for publication on the Live site.

Microsoft Graph

1. Guidance for Graph PRs is documented in the Graph Content Wiki.

2. The minimum requirements for a PR to be publishable are as follows:

   ✔ Include docs for all the API changes/additions you're making, as specified by your updates to the metadata. For example, each entity, complex type, and applicable CRUD operation, action, and function must have its own topic.

   ✔ Author API reference content in topic structures consistent with guidance.

   ✔ All v1.0 API pages must have corresponding beta API pages.

   ✔ Expose API entry points as appropriate in the reference TOC.

   ✔ Include changelog items for API additions and updates, or any other updates that impact API behavior, such as adding a permission for an API.

   ✔ Address API Doctor warnings and errors in the content you updated in the PR.

Preparing for weekly Shiproom.