Как мы оформляем наши dbt проекты

Почему стиль имеет значение?

Стиль может показаться незначительной, поверхностной проблемой, но это важный аспект хорошо построенного проекта. Последовательный и ясный стиль улучшает читаемость и делает ваш проект более понятным и легким в поддержке. Высокая читаемость кода помогает строить четкие ментальные модели, что облегчает отладку и расширение вашего проекта. Это не только услуга самому себе; не менее важно, что это снижает усилия, необходимые другим для понимания и вклада в ваш проект, что является ключевым для совместной работы, работы с открытым исходным кодом и адаптации новых членов команды. Руководство по стилю позволяет сосредоточиться на том, что действительно важно, на логике и влиянии вашего проекта, а не на поверхностных аспектах его написания. Это приносит гармонию и темп в работу вашей команды и делает обзоры более приятными и ценными.

Что важно в стиле?

Существует два ключевых принципа стиля кода:

• Ясность
• Последовательность

Оформляйте ваш код так, чтобы его можно было быстро прочитать и понять. Также важно учитывать обзор кода и git-диффы. Если вы вносите изменения в модель, вы хотите, чтобы рецензенты четко видели только те изменения, которые вы вносите.

Как только вы установили ясный стиль, придерживайтесь его. Это самое важное. Все в вашей команде должны иметь единый стиль, поэтому наличие руководства по стилю так важно. Если вы пишете модель, вы должны иметь возможность посмотреть на другие модели в проекте, написанные вашими коллегами, и прочитать их в том же стиле. Если вы пишете макрос или тест, вы должны видеть тот же стиль, что и в ваших моделях. Последовательность — это ключ.

Как мне оформить?

Вы должны оформить проект так, как вы и ваши коллеги или соавторы согласны. Самое важное — это иметь руководство по стилю и придерживаться его. Это руководство — всего лишь предложение, чтобы помочь вам начать и дать представление о том, как может выглядеть руководство по стилю. Оно охватывает различные области, которые вы можете захотеть рассмотреть, с предложенными правилами. Оно подчеркивает важность большого количества пробелов, ясности, четкого именования и комментариев.

Мы считаем, что одной из сильных сторон SQL является то, что он читается как английский, поэтому мы опираемся на эту декларативную природу во всех наших проектах. Даже в dbt Labs существуют разные мнения о том, как оформлять, включая небольшую, но страстную группу энтузиастов ведущих запятых! Опять же, важно не следовать этому руководству по стилю; важно создать ваше руководство по стилю и следовать ему. Наконец, обязательно включите правила, инструменты и примеры в ваше руководство по стилю, чтобы сделать его как можно более простым для вашей команды.

Автоматизация

Используйте форматтеры и линтеры как можно больше. Мы все люди, мы совершаем ошибки. Более того, у всех нас разные предпочтения и мнения при написании кода. Автоматизация — отличный способ обеспечить, чтобы ваш проект был оформлен последовательно и правильно, и чтобы люди могли писать так, как им удобно и быстро, при этом получая идеально последовательный результат.