Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modify model naming conventions to account for model versioning #89

Open
SamHarting opened this issue Apr 21, 2023 · 4 comments
Open

Modify model naming conventions to account for model versioning #89

SamHarting opened this issue Apr 21, 2023 · 4 comments

Comments

@SamHarting
Copy link

SamHarting commented Apr 21, 2023

In the 1.5 release we will be introducing model versioning! 🥂 🥳

As a result a model will have two parts:

  • The model name which is defined using the name configuration and will be used in the {{ ref() }} function
  • The file name which will show up in the directory and is pointed to in the yml configuration defined_in

As a result we will need to update our style guide to demonstrate how we think both the model name and file name should be structured.

@SamHarting
Copy link
Author

SamHarting commented Apr 21, 2023

My opinion:
model name: We keep this the same as our current suggestions.
file name: This would just be the model name with a _v# appended to the end

During our training it was mentioned it could be anything such as _old and _new. I am not a fan of this because then it requires maintenance of the file names. That would be okay if it was all related to merges but since we are on track to schedule deprecation I am not sure that this would be a reliable way of doing things since the point a model should be renamed is no longer associated with a manual change.

@SamHarting
Copy link
Author

Another consideration here is IDE functionality. We now have the ability to copy file names or copy a reference to the model. Does the IDE use YML configurations to figure this stuff out or is it going strictly on file name? Is this something worth considering when making the naming conventions?

@wasilaq
Copy link

wasilaq commented Apr 28, 2023

I heard something about our style guide being updated a while back (I think @gwenwindflower was owning that initiative?). Worth checking if/when that's happening before updating our current guide!

@gwenwindflower
Copy link
Contributor

Great callout, Sam, and thank you for the tag Wasila -- will add to the new guide!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants