foul

Database Reviewer Checklist

Thank you for becoming a database reviewer! Please work on the list below to complete your setup. For any question, reach out to #database an mention @abrandl.

  • Change issue title to include your name: Database Reviewer Checklist: Your Name
  • Review general code review guide
  • Review database review documentation
  • Familiarize with migration helpers and review usage in existing migrations
  • Read database migration style guide
  • Familiarize with best practices in database guides
  • Watch Optimising Rails Database Queries: Episode 1
  • Read Understanding EXPLAIN plans
  • Review database best practices
  • Review how we use database instances restored from a backup for testing and make sure you're set up to execute pipelines (check README.md and reach out to @abrandl since this is currently subject to being changed)
  • Get yourself added to @gl-database group and respond to @-mentions to the group (reach out to any maintainer on the group to get added). You will get TODOs on gitlab.com for group mentions.
  • Make sure you have proper access to at least a read-only replica in staging and production
  • Indicate in data/team.yml your role as a database reviewer (example MR). Assign MR to your manager for merge.
  • Send one MR to improve the review documentation or the issue template

Note that approving and accepting merge requests is restricted to Database Maintainers only. As a reviewer, pass the MR to a maintainer for approval.

You're all set! Watch out for TODOs on GitLab.com.

Where to go for questions?

Reach out to #database on Slack and mention @abrandl for any questions.

cc @abrandl

Assignee Loading
Time tracking Loading