Skip to content

Commit

Permalink
Update style_guide
Browse files Browse the repository at this point in the history
  • Loading branch information
hollyfurniss-moj authored Jul 24, 2024
1 parent daf00ff commit b563c31
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions source/documentation/tools/create-a-derived-table/style_guide
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Style might seem like a trivial, surface-level issue, but it's an important aspe

As a group of Analytics Engineers, we have thoroughly reviewed guidance published by dbt (the technology behind create-a-derived-table) and adapted it to suit our needs in this style guide.

Please take the time to familiarise yourself with this style guide, and our guidance on project structure [add link], before starting projects in create-a-derived-table.
Please take the time to familiarise yourself with this style guide before starting projects in create-a-derived-table.

## What's important about style?

Expand All @@ -29,8 +29,8 @@ Once you've established a clear style, stay consistent. This is the most importa
## Fields and model names

### Essential styling
- πŸ”‘ Each model should have a primary key and that primary key should be the first field in the table.
- πŸ”‘ The primary key of a model should be named `<object>_id`, for example, `account_id`. This makes it easier to know what `id` is being referenced in downstream joined models.
-πŸ”‘ Each model should have a primary key and that primary key should be the first field in the table.
-πŸ”‘ The primary key of a model should be named `<object>_id`, for example, `account_id`. This makes it easier to know what `id` is being referenced in downstream joined models.
- Use underscores for naming dbt models; avoid dots or camel case.
- βœ… `models_without_dots`
- ❌ `models.with.dots`
Expand Down

0 comments on commit b563c31

Please sign in to comment.