Hey all! My team at work is struggling with growing pains of getting into a formalized review process, so I was wondering if any of you guys have some things to live or die by in your code reviews. How much of it is manual, or how much is just static code analysis + style guide stuff, etc?
I’m a senior at a large tech company - I push all the teams I work with to automate the review process as much as possible. At minimum, teams must have a CI hook on their pull request process that runs a remote dryrun build of the changed packages. The dryrun makes sure the packages compile, pass unit tests and meet linter rules. A failed build blocks the pull request from being merged.
I try to encourage developers to turn the outcome of every code style discussion into a lint rule that fails the dryrun build when its violated.
Current place:
- Work is done on a feature branch on a personal fork of the repo
- Codebase requires 100% functional coverage, and you’re responsible for writing the tests for your code and including that in the same PR
- Run pre-commit hooks for style auto-formatters before you can commit and push your code to your origin fork
- Ideally run local tests as well
- Create a PR to pull feature branch into the upstream repo’s main branch, which triggers the CI pipeline for style and tests
- At least 1 other person must review the code before a PR can be approved and merged into upstream main
- There’s a separate CI pipeline for testing of publishing the packages to TestPyPI
- Releases to PyPI are currently done manually
Small startup - Here is our process
- Create your branch
- Implement feature
- Test independently of other components (with unit tests or otherwise)
- Test directly with other componenets
- Work with other devs to ensure stability on dev branch, make any small bug fixes directly in dev branch
- Push to prod
We use a version of Git Flow for branching (since everyone is talking about branching strategies here). But technically, you asked specifically about code review process. Every ticket is it’s own branch against the
development
branch, and when complete is merged by PR into the development branch. We’re a small team, so our current process is:- Merges to the development branch require one approval
- Merges to the main branch for a release require two approvals
- If the changes are only code, any developer can review and approve
- If there are “significant” SQL changes a DBA approval is required.
- “significant” means a new entity in the DB, or…
- an inline/Dapper query with a join
As we grow we’ll probably have to silo more and require specific people’s approval for specific areas.
A lot of what we do is “cultural”, like encouraging readability, avoiding hard-coded values, and fixing issues near the altered code even when not related to the original ticket. The key is to be constructive. The goal is better code, not competition. So far we have the right people for that to work.
At my work we use trunk based development, with mandatory review before merging (enforced by tooling). Part of the review is ensuring proper test coverage and it’s enhanced by static code analysis.
Ours is pretty intense - large bank, 60 or so iOS engineers actively contributing to a mono-repo:
- We have about 15 CI steps that pick up on anything from basic linting to security concerns (SonarQube). Unit tests, UI tests, etc.
- We have a template that PR authors follow to add descriptions, test plans, devices tested on.
- Reviewers are automatically assigned using a round robin system
- Reviewers obviously review the code, but also execute the test plan, which includes accessibility testing.
- All PRs require 2 approvals.
- A bunch of other stuff (uploading artefacts, generating gRPC protos) that probably isn’t worth going into detail.
It’s intense, and PRs on average take a week or so to get merged. In saying that, it is the highest quality and most well-architected codebase I have ever worked on.
If I were in your situation I’d push for the following:
- all PRs have one approval, preferably two depending on team size
- code is tested by someone else before being merged to main
- use linters, Danger, etc to pick up on trivial shit
- a few manual checks like ensuring code is unit tested
- a Github PR Reviewer guide describing common issues to look for, tone of messaging when leaving comments (“be nice”, “make it clear when you are adding optional nit-picks”, etc)
- encourage authors to add review comments to their own PRs for any bit of code that isn’t immediately obvious
- stretch goal: look into generating code coverage reports on your PRs, add quality gates
have you looked at Git Flow? Its pretty solid.
My team has a develop branch from which we branch feature branches. On it we commit our stuff and when we think its feature complete we build a snapshot version of it so that our QA can test it. Once that test was successful, and the code has been peer reviewed, it will be merged back onto develop.
PRs will be auto built so that the feature can be integrated and automated tested.
There is trunk based way. Although I have not used it heavily at work. https://trunkbaseddevelopment.com/
My team is very small (3 people). We mostly trust each other on just merging away without PR reviews. Although we ask for reviews when in doubt during development, not when ready to merge. Mostly for asking ideas on where to put stuff.
On my previous work, we were like a 15+ dev team, doing mandatory PR reviews before merging and doing the shotgun request (ping @review_channel and pray). I hated it.