Trainee FE Maintainer (GitLab) - Thomas Randolph
Read the code review page in the handbook and the code review guidelines.
Understand how to become a maintainer and add yourself as a trainee maintainer in the team database.
Working towards becoming a maintainer
These are only guidelines. Remember that there is no specific timeline on this.
As part of your journey towards becoming a maintainer, you may find it useful to:
Act as a coach in a big deliverable that requires following the planning step as part of the trainee program.
Shadow a maintainer while they review an MR. This will allow you to get insight into the thought processes involved.
Have a maintainer shadow you while you review an MR as if you were a maintainer . Ideally, this would be with a different maintainer to the above, so you can get different insights.
It is up to you to ensure that you are getting enough MRs to review, and of varied types. All engineers are reviewers, so you should already be receiving regular reviews from Reviewer Roulette. You could also seek out more reviews from your team, or #frontend Slack channels.
Your reviews should aim to cover maintainer responsibilities as well as reviewer responsibilities. Your approval means you think it is ready to merge.
After each MR is merged or closed, add a discussion to this issue using this template:
### (Merge request title): (Merge request URL) During review: - (List anything of note, or a quick summary. "I suggested/identified/noted...") Post-review (opportunities to learn): - (List anything of note, or a quick summary. "I missed..." or "Merged as-is") (Maintainer who reviewed this merge request) Please add feedback, and compare this review to the average maintainer review.
The purpose of comparing your review to the maintainer's review is to engage in active learning and expand your list of items to consider. Remember, different maintainers are going to identify different issues in the same code. As long as you are not missing large errors or bugs, don't feel like you are doing a bad job if you and a maintainer make different suggestions.
Note: Do not include reviews of security MRs because review feedback might reveal security issue details.
Tip: There are tools available to assist with this task.
Code Review Pairing
Much like pair programming, pairing on code review is a great way to knowledge share and collaborate on merge request. This is a great activity for trainee maintainers to participate with maintainers for learning their process of code review.
A private code review session (unrecorded) involves one primary reviewer, and a shadow. If more than one shadow wishes to observe a private session, please consider obtaining consent from the merge request author.
A public code review session involves a primary reviewer and one or more shadows in a recorded session that is released publicly, for example to GitLab Unfiltered.
- If the merge request author is a GitLab team member, please consider obtaining consent from them.
- If the merge request author is a community contributor, you must obtain consent from them.
- Do not release reviews of security merge requests publicly.
When you're ready to make it official
When reviews have accumulated, and recent reviews consistently fulfill maintainer responsibilities, any maintainer can take the next step. The trainee should also feel free to discuss their progress with their manager or any maintainer at any time.
Create a merge request updating your team member entry proposing yourself as a maintainer.
Keep reviewing, start merging 🤘