diff --git a/docs/contributing/project-details/migrations.md b/docs/contributing/project-details/migrations.md index 1aad52c4..d2c80c02 100644 --- a/docs/contributing/project-details/migrations.md +++ b/docs/contributing/project-details/migrations.md @@ -2,7 +2,7 @@ There are some important considerations to make when adding a feature with a db migration. -* DB Migrations also require publishing a new API version as the migrations also need to be applied there. +* DB Migrations will require publishing a new API version as the migrations also need to be applied there. * The AQL Schema file will likely need to be updated to match any table changes. @@ -10,6 +10,6 @@ There are some important considerations to make when adding a feature with a db * The naming convention is as follows: `TIMESTAMP_name.sql`. for example. `1694438752000_add_goal_targets.sql` -* It is strongly discouraged to try to remove columns and tables, This makes reverting changes impossible and introduces unnecessary risk when we can simply stop using them in code. +* It is strongly discouraged to try to remove columns and tables. This makes reverting changes impossible and introduces unnecessary risk when we can simply stop using them in code. * You should be very deliberate with your migration. When adding a feature, try to think about future scenarios and options that may be desired later, so we can minimize the number of migrations.