November 2021 Summaries

Code review is an essential practice for engineers to ensure best practices, educate developers, and find defects or opportunities for improvement in code. Google principles emphasize technical facts over opinions and encourage providing resources and explanations when requesting changes. A good code review process should include guidelines on who to ask for a review, how many approvals are needed, mandatory checks before merging the pull request, and daily short sessions of less than an hour for reviewing. Understanding what is being reviewed, testing the code before looking at it, and keeping reviews fast are also crucial aspects. Large tasks should be separated into small pull requests to improve efficiency, and a good pull request template with a checklist can help prepare for the review.

Pull requests and code reviews are essential workflows for high-performing engineering teams, aiding in efficient collaboration and quality assurance. The process begins with draft pull requests, allowing engineers to indicate ongoing work and prepare content for peer review, which can later be converted to ready-for-review status. Reviewers can suggest changes through specific comments and request modifications, while conflicts can be resolved either via the IDE or GitHub UI. Approval from reviewers signals readiness for merging, with options such as creating a merge commit, squashing, or rebasing. Stacked pull requests can help manage large tasks or enable multiple engineers to work on the same feature. Best practices include clearly stating the purpose of requests, using formal language, involving relevant team members, and employing positive communication during reviews to foster team growth and improve product quality. Additionally, GitHub's pull request checks, CLI tools, and integration with third-party applications enhance workflow efficiency and notification management.

GitHub Pull Requests are a way for developers to propose changes to a project's codebase, allowing others to review and discuss the proposed modifications before they are merged into the main branch. The primary advantage of pull requests is that they facilitate code reviews, ensuring that new features or fixes meet organizational guidelines and align with the overall architectural vision. Pull requests can be opened by anyone who has made changes to a project's codebase on a separate branch, and reviewers are typically team members experienced in the relevant area of the code. GitHub offers both free and paid plans, with the free version allowing users to create personal public and private repositories, as well as open issues, pull requests, and projects. Branches in GitHub allow developers to isolate their work without affecting other branches, making it easy to switch between different branches or create new ones. Forking a repository on GitHub creates a copy of the original project, enabling users to make changes and propose them to the owner or use the forked project as a starting point for their own ideas. Comparing two branches in GitHub can be done by adding "/compare" at the end of the URL or through opening a pull request. Protected branches on GitHub allow administrators to enforce certain requirements, such as pull request reviews and status checks before merging, ensuring that only verified commits are pushed and maintaining linear history for easier change reversals.