Code Review Process

A key aspect of maintaining code quality and security is the protection of the main branch. This ensures that changes can only be merged into the main branch after a review process, thus preventing unauthorized or potentially harmful code from being incorporated. GitHub Branch Protection is enabled by default for all repositories within the Allianz GitHub organization. If necessary, this default behavior can be customized for specific repositories by sending a request to [email protected].

The following outlines a typical workflow for managing code reviews:

1. Create an issue, if not existing yet, to discuss what you want to implement
2. Fork the repository and create your branch from main
3. Push changes to your fork and open a pull request
   • Fill in the required PR template, if exists
   • Add a summary of all major changes in the description
   • Link the pull request and the issue being resolved
   • Enable the option allow maintainers edits for faster merging
   • Apply suggest changes from reviewers. You can do so directly in the Github UI or commit changes to your fork
   • Mark each suggested change as resolved
   • Re-request a review when you are done with all changes
4. Make sure automated tests do not have errors
   • With errors a PR might be ignored and not receive reviews.
   • If you need a review despite test errors, then mark your PR as draft.

For more details and recommendations, please see the official documentation.