Search code examples
entity-frameworknaming-conventions

Is there a best or recommended practice for naming Entity Framework migrations?

When using Entity Framework code first migrations is there a best practice for choosing a name for each migration? For example each name might contain a version number or the change(s) made to the model or both.

Add-Migration Added Manager.Employees
Add-Migration Add_Employee_ManagerId
Add-Migration version 2
Add-Migration v2_Add_Employee_ManagerId

Any tips for selecting a good naming strategy for a project with multiple developers and many migrations?

I found a similar question but no answers.

Solution

  • In the Microsoft docs it states:

    The migration name can be used like a commit message in a version control system. For example, if I made changes to save customer reviews of products, I might choose something like AddProductReviews.

    So by their provided example of AddProductReviews I'm thinking that Upper Camel Case is what Microsoft recommends.

    https://learn.microsoft.com/en-us/ef/core/managing-schemas/migrations/