Skip to content

Commit

Permalink
Document source models and sources.
Browse files Browse the repository at this point in the history
  • Loading branch information
jaypeedevlin authored and sean-rose committed Nov 30, 2021
1 parent 98f7326 commit 3834d3b
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions dbt_coding_conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,8 @@ Sources have some nice features:
- Testing source columns.
- Calculating the freshness of source data.

Sources should have the `description` and `loader` properties completed to give context on the source to future developers.

<br>

## Models
Expand Down Expand Up @@ -449,6 +451,8 @@ Having a separate schema `.yml` file for each model has several benefits:
- Clearly shows which models have documentation/tests and which don't.
- Helps avoid version control merge conflicts.

Final models and source models should be documented. Intermediate models do not require documentation.

<br>

#### A model is not complete without tests and documentation.
Expand Down

0 comments on commit 3834d3b

Please sign in to comment.