Merge requests

Once you've made your changes and you think they're ready for Max, you can open a merge request.

First, go to the merge requests tab on the GitHub page for Max and click on new pull request. Select the base branch to be dev (or any other target branch other than main you may have). Alternatively, you can click on this link. Now, you select the branch with your changes as the compare branch and click on create pull request. The pull request title should follow the same format as your branch's name, but you can add spaces, for example: RenderManager - 42 - Add Blinn-Phong shader. You can create the pull request by clicking on Create pull request.

Passing review

Once a merge request has been created, two things will happen:

• GitHub will automatically run some tests on your changes
• Another contributor will review your changes

In order to get a merge request accepted, the following must be true:

• The version of Max with your changes compiles
• All the automated GitHub checks pass. If they don't, you can click on details for the failing test, which will tell you exactly why the test failed. If you push new commits to your branch, they will automatically be added to the merge request, and the tests will be re-run.
• The changes follow the style guide
• Another contributor has reviewed your code and has deemed it okay for it to be merged to the target branch. Contributors can leave comments and change suggestions on the merge request page, some of which can be applied automatically with the press of a button. Others may require you to make new changes and push it to your branch. Then, your merge request can be reviewed again.