Skip to main content

Code-Review

Every PR that wants to merge commits in the main branch must be code reviewed and approved before the merge.

These are the code review steps to be followed:

  1. developer start coding changes
  2. developer can open PR in draft state if needed
  3. developer choose another person to code review the drafted PR
  4. when development is finished, PR can be set as ready for review. If there are very little changes, the trivial change label can be added
  5. if more development is needed (impacting development, not typos or little style changes), the developer should bring the PR back to draft state
  6. when the PR has been approved by another person, the author can merge it anytime

Responsibilities​

Developer​

The person who's proposing changes to the codebase must be aware of what the scope of the change is, why we are doing it and the implication of it. Please avoid picking the description of a task and implementing it without understanding it, we're not task executors, we're part of a team. We're asking you to do the better you can: propose refactors if needed, ask about any unresolved doubt that came out of your mind in the whole development process, take your time to propose a good code. Another good advice is to review the PR yourself before asking to other to do it, this can avoid comments that yourself would have wrote. When code reviewing, the main rule to follow is to be humble and honest with yourself and the whole team: if you don't know something, ask to the others, don't do closed eye approval. Having the full understand of the codebase is very hard, so if you're reviewing changes in an area that you don't know, there will surely be also another person that can do the review with you.