Pull Requests

We use GitHub Pull Requests to merge completed work into main, rather than pushing changes directly. Our repository is set up so that the CI builds must complete successfully before a PR can be merged.

Code Reviews

Team Members

All Engine Team Members have commit authority to the repository. As trusted committers, they are able to decide whether a code review is needed and on a particular PR and to request one if it is. If a review is wanted from a specific team member, that member should be named as a reviewer. Otherwise, select the engine team itself as the reviewer and any of us can review.

Whether to request a review or not is a judgement call on the part of the team member creating the PR. Here are some factors, which may be considered in making the decision. Others may occur to you!

• What kind of change is it? (a new feature, an enhancement, a bug fix, refactoring code, updating the build script, etc.)
• Does the change fit clearly with our vision for the project.
• Are significant architectural changes included
• Is the PR large or small?
• Are the code changes simple or complicated?
• Are there areas of uncertainty you want to have looked at?
• Is the change urgent? Is it blocking other changes?
• Are other team members available to do the review.

Other Contributors

A code review is required before merging a PR from a contributor without commit authority. Any of the team members who has time available is able to perform the review, request changes as needed and either merge or reject the PR. It's up to the reviewing team member to decide if input from others is needed and to request additional reviews in that case.