Pull Request Review and Approval Process

Why review Pull Requests?

When a number of developers are working on a large code repository, it's important that everyone is merging code into the main branch without any breaking changes and following code style guidelines. A Pull Request helps this by allowing a other developers to see and validate the code that has been written adhere to these guidelines.

Pull Request Criteria

1. The Pull Request must be related to approved design relating to the Yumble project.
2. Make sure to assign yourself and the linking issue for the Pull Request
3. The Pull Request must follow the Pull Request Schema

Pull Request Approval Process

1. Someone other than the author ensures that all Pull Request criteria has been met, there must be at least 2 approved reviews.
2. The author and the reviewers must ensure that the code in Pull Request passes all checks for CI.
3. Leave a comment informing the author whether the criteria has been met.
4. If it has not been met then proper feedback will be given to the author with either a simple comment or a comment that has been linked to a piece of code the author has written.
5. If the criteria has been met the reviewer will leave a positive comment and squash and merge the pull request into the main branch.