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. It saves time by automating something devs were doing manually anyway (reading every line of code to look for their code style pet peeves) and it also makes the dialogue healthier - devs can talk about the team standards and whether the code meets them, instead of making subjective comments about one another’s code style.
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
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
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.
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.