Script header/comments - What are your best practise recommendations?

In-Depth Discussions
,
1

Hi everyone,
My team are brand new to dbt. We are a BI Engineering team that produce datasets/views etc for our Visualisation Team to produce dashboards etc from. We are moving from doing all of our sql development from Snowflake into dbt cloud. I have been used to having a header on each of my .sql files explaining things like Author, Date Created, Version No., Description of what script does, and then any revisions made/new code added in (dates, author, description).

Moving to dbt, I was wondering what, if any, people do with regards having such headers/general commenting of code throughout.

Any comments/thoughts/ideas would be greatly appreciated.

With thanks
Iain M.

2

We use the query_comment variable in our project to put a lot of metadata in a comment and the bottom of all of our quereis. We then use that metadata to connect to other data like out Airflow and CI invocations.