Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README dbt url #46

Merged
merged 3 commits into from
Jun 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@

`dbt-score` is a linter for dbt model metadata.

[dbt](https://getdbt.com/) (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.
[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
Expand All @@ -24,17 +24,20 @@ 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.
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](https://dbt-score.picnic.tech/).
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](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