P0 Checklist

This list is a practical, minimal, non-exhaust checklist that contains the P0 area to look for when reviewing a PR. This can be seen as a best practice list to both PR reviewer and PR author.

Contributing

Given this list is of the top priority, we would like to keep it minimal and consensual. To make it to this list, the corresponding rule must be thoroughly discussed and reviewed by the code review committee.

• Always keep your migration code and other code in separate PRs.

  • Isolate code change and migration change as code change can be easily rolled back, while migration can not.
  • migration can get executed first, while code got deployed later, so if your migration is not backward compatible there will be a window of downtime.

• Enable the ValidateMigrationNaming flag for your migrate.sh script.

  This flag will validate the naming convention of your migration files. Below are the steps:

  • Example  of enabling the flag in the migrate.sh script.
  • Example  of setting the location of the migration files to limit the scope of the validation.