Skip to content

Commit f9096e2

Browse files
Update README.md
1 parent ddcf632 commit f9096e2

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
<!--ts-->
44
* [dbt_metrics](#dbt_metrics)
55
* [About](#about)
6-
* [Installation Instructions](#installation-instructions)
6+
* [Tenets](#tenets)
7+
* [Installation Instructions](#installation-instructions)
78
* [Usage](#usage)
89
* [Use cases and examples](#use-cases-and-examples)
910
* [Jaffle Shop Metrics](#jaffle-shop-metrics)
@@ -28,9 +29,19 @@
2829

2930
<!--te-->
3031

32+
33+
3134
# About
3235
This dbt package generates queries based on [metrics](https://docs.getdbt.com/docs/building-a-dbt-project/metrics), introduced to dbt Core in v1.0. For more information on metrics, such as available types, properties, and other definition parameters, please reference the documentation linked above.
3336

37+
## Tenets
38+
The tenets of `dbt_metrics`, which should be considered during development, issues, and contributions, are:
39+
- A metric value should be consistent everywhere that it is referenced
40+
- We prefer generalized metrics with many dimensions over specific metrics with few dimensions
41+
- It should be easier to use dbt’s metrics than it is to avoid them
42+
- Organization and discoverability are as important as precision
43+
- One-off models built to power metrics are an anti-pattern
44+
3445
## Installation Instructions
3546
Check [dbt Hub](https://hub.getdbt.com/dbt-labs/metrics/latest/) for the latest installation instructions, or [read the docs](https://docs.getdbt.com/docs/package-management) for more information on installing packages.
3647

0 commit comments

Comments
 (0)