From 2161b5f692f59325a5ee29ae5af6984bad719ac7 Mon Sep 17 00:00:00 2001 From: Max Sumrall Date: Tue, 11 Jun 2024 13:22:24 +0200 Subject: [PATCH 1/3] Update README to link to dbt-core url --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cc6249e..5cbc234 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ `dbt-score` is a linter for dbt model metadata. -[dbt](https://getdbt.com/) (Data Build Tool) is a great framework for creating, +[dbt][dbt] (Data Build Tool) is a great framework for creating, building, organizing, testing and documenting _data models_, i.e. data sets living in a database or a data warehouse. Through a declarative approach, it allows data practitioners to build data with a methodology inspired by software @@ -31,10 +31,16 @@ and enforce metadata rules, in an easy and scalable manner. ## Documentation Everything you need (and more) can be found in -[`dbt-score` documentation website](https://dbt-score.picnic.tech/). +[`dbt-score` documentation website][dbt-score]. ## Contributing Would you like to contribute to `dbt-score`? That's great news! Please follow -[the guide on the documentation website](https://dbt-score.picnic.tech/contributors_guide). +[the guide on the documentation website][contributors-guide]. 🚀 + +[dbt]: https://github.com/dbt-labs/dbt-core + +[dbt-score]: https://dbt-score.picnic.tech/ + +[contributors-guide]: https://dbt-score.picnic.tech/contributors_guide From 42214dcdd5ccaa4e09932cc44674f443ac1f9df1 Mon Sep 17 00:00:00 2001 From: Max Sumrall Date: Tue, 11 Jun 2024 13:27:05 +0200 Subject: [PATCH 2/3] Reformat README line wrapping after moving URLs --- README.md | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 5cbc234..52cc4ac 100644 --- a/README.md +++ b/README.md @@ -11,22 +11,18 @@ `dbt-score` is a linter for dbt model metadata. -[dbt][dbt] (Data Build Tool) is a great framework for creating, -building, organizing, testing and documenting _data models_, i.e. data sets -living in a database or a data warehouse. Through a declarative approach, it -allows data practitioners to build data with a methodology inspired by software -development practices. - -This leads to data models being bundled with a lot of metadata, such as -documentation, data tests, access control information, column types and -constraints, 3rd party integrations... Not to mention any other metadata that +[dbt][dbt] (Data Build Tool) is a great framework for creating, building, organizing, testing and documenting _data +models_, i.e. data sets living in a database or a data warehouse. Through a declarative approach, it allows data +practitioners to build data with a methodology inspired by software development practices. + +This leads to data models being bundled with a lot of metadata, such as documentation, data tests, access control +information, column types and constraints, 3rd party integrations... Not to mention any other metadata that organizations need, fully supported through the `meta` parameter. -At scale, with hundreds or thousands of data models, all this metadata can -become confusing, disparate, and inconsistent. It's hard to enforce good -practices and maintain them in continuous integration systems. This is where -`dbt-score` plays its role: by allowing data teams to programmatically define -and enforce metadata rules, in an easy and scalable manner. +At scale, with hundreds or thousands of data models, all this metadata can become confusing, disparate, and +inconsistent. It's hard to enforce good practices and maintain them in continuous integration systems. This is +where`dbt-score` plays its role: by allowing data teams to programmatically define and enforce metadata rules, in an +easy and scalable manner. ## Documentation From 434f56bc0fe04608cbaca94736f74791ba03e9cd Mon Sep 17 00:00:00 2001 From: Max Sumrall Date: Tue, 11 Jun 2024 13:52:43 +0200 Subject: [PATCH 3/3] Format with prettier --- README.md | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 52cc4ac..d3f18ea 100644 --- a/README.md +++ b/README.md @@ -11,32 +11,33 @@ `dbt-score` is a linter for dbt model metadata. -[dbt][dbt] (Data Build Tool) is a great framework for creating, building, organizing, testing and documenting _data -models_, i.e. data sets living in a database or a data warehouse. Through a declarative approach, it allows data -practitioners to build data with a methodology inspired by software development practices. - -This leads to data models being bundled with a lot of metadata, such as documentation, data tests, access control -information, column types and constraints, 3rd party integrations... Not to mention any other metadata that +[dbt][dbt] (Data Build Tool) is a great framework for creating, building, +organizing, testing and documenting _data models_, i.e. data sets living in a +database or a data warehouse. Through a declarative approach, it allows data +practitioners to build data with a methodology inspired by software development +practices. + +This leads to data models being bundled with a lot of metadata, such as +documentation, data tests, access control information, column types and +constraints, 3rd party integrations... Not to mention any other metadata that organizations need, fully supported through the `meta` parameter. -At scale, with hundreds or thousands of data models, all this metadata can become confusing, disparate, and -inconsistent. It's hard to enforce good practices and maintain them in continuous integration systems. This is -where`dbt-score` plays its role: by allowing data teams to programmatically define and enforce metadata rules, in an -easy and scalable manner. +At scale, with hundreds or thousands of data models, all this metadata can +become confusing, disparate, and inconsistent. It's hard to enforce good +practices and maintain them in continuous integration systems. This is +where`dbt-score` plays its role: by allowing data teams to programmatically +define and enforce metadata rules, in an easy and scalable manner. ## Documentation -Everything you need (and more) can be found in -[`dbt-score` documentation website][dbt-score]. +Everything you need (and more) can be found in [`dbt-score` documentation +website][dbt-score]. ## Contributing Would you like to contribute to `dbt-score`? That's great news! Please follow -[the guide on the documentation website][contributors-guide]. -🚀 +[the guide on the documentation website][contributors-guide]. 🚀 [dbt]: https://github.com/dbt-labs/dbt-core - [dbt-score]: https://dbt-score.picnic.tech/ - [contributors-guide]: https://dbt-score.picnic.tech/contributors_guide