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.

Sign up for GitHub

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

Jump to bottom

Add medals to scoring #32

Merged
merged 21 commits into from
Jun 3, 2024
Merged

Add medals to scoring #32

merged 21 commits into from
Jun 3, 2024

Conversation

jochemvandooren
Copy link
Contributor

@jochemvandooren jochemvandooren commented May 27, 2024 •
edited
Loading

Models can now receive a badge based on their score:

  • Badge thresholds can be configured
  • Badges are added to the output

@jochemvandooren jochemvandooren self-assigned this May 27, 2024
@jochemvandooren jochemvandooren marked this pull request as ready for review May 27, 2024 12:56
druzhinin-kirill
druzhinin-kirill reviewed May 27, 2024
View reviewed changes
Copy link
Contributor

@druzhinin-kirill druzhinin-kirill left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🥇

tests/resources/pyproject.toml Outdated Show resolved Hide resolved
src/dbt_score/scoring.py Outdated Show resolved Hide resolved
src/dbt_score/formatters/manifest_formatter.py Outdated Show resolved Hide resolved
src/dbt_score/scoring.py Outdated Show resolved Hide resolved
@jochemvandooren
Copy link
Contributor Author

@matthieucan Do you think we should also add the configuration options to the CLI?

@matthieucan
Copy link
Contributor

@matthieucan Do you think we should also add the configuration options to the CLI?

I don't think so, such options would be rather static, as in "for a given dbt project, all users use the same thresholds". Let's keep CLI options for things that are likely changing across different runs?

matthieucan
matthieucan reviewed May 27, 2024
View reviewed changes
src/dbt_score/scoring.py Outdated Show resolved Hide resolved
src/dbt_score/scoring.py Outdated Show resolved Hide resolved
src/dbt_score/scoring.py Outdated Show resolved Hide resolved
src/dbt_score/formatters/human_readable_formatter.py Outdated Show resolved Hide resolved
@jochemvandooren
Copy link
Contributor Author

@matthieucan Do you think we should also add the configuration options to the CLI?

I don't think so, such options would be rather static, as in "for a given dbt project, all users use the same thresholds". Let's keep CLI options for things that are likely changing across different runs?

Ok makes sense, I think it would be a little bit too much indeed 👍

matthieucan
matthieucan reviewed May 29, 2024
View reviewed changes
src/dbt_score/config.py Outdated Show resolved Hide resolved
src/dbt_score/config.py Outdated Show resolved Hide resolved
src/dbt_score/config.py Outdated Show resolved Hide resolved
src/dbt_score/lint.py Outdated Show resolved Hide resolved
src/dbt_score/scoring.py Outdated Show resolved Hide resolved
tests/formatters/test_manifest_formatter.py Outdated Show resolved Hide resolved
@matthieucan matthieucan mentioned this pull request May 29, 2024
Merged
matthieucan
matthieucan reviewed May 30, 2024
View reviewed changes
tests/resources/pyproject.toml Outdated Show resolved Hide resolved
src/dbt_score/config.py Outdated Show resolved Hide resolved
matthieucan
matthieucan reviewed May 30, 2024
View reviewed changes
docs/configuration.md Show resolved Hide resolved
docs/configuration.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/rules/generic.md Outdated Show resolved Hide resolved
matthieucan
matthieucan reviewed May 30, 2024
View reviewed changes
docs/configuration.md Outdated
Comment on lines 24 to 31
[tool.dbt-score.badges]
first.threshold = 9.5
first.icon = "1️⃣"
second.threshold = 7.5
second.icon = "2️⃣"
third.threshold = 6.5
third.icon = "3️⃣"
wip.icon = "🏗️"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would put this section above the rule section, and keep the default values, to avoid confusion. WDYT?

docs/index.md
@@ -12,15 +12,16 @@ encourage) good practices.

```shell
$ dbt-score lint
Model customers
🥇 customers (score: 10.0)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🥇

matthieucan
matthieucan approved these changes Jun 3, 2024
View reviewed changes
Copy link
Contributor

@matthieucan matthieucan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small phrasing suggestion, otherwise LGTM! 🚀

docs/configuration.md Outdated Show resolved Hide resolved
@jochemvandooren jochemvandooren merged commit 1631b4f into master Jun 3, 2024
2 checks passed
@jochemvandooren jochemvandooren deleted the jvandooren/medals branch June 3, 2024 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@druzhinin-kirill druzhinin-kirill druzhinin-kirill approved these changes

@matthieucan matthieucan matthieucan approved these changes

Assignees

@jochemvandooren jochemvandooren

Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jochemvandooren @matthieucan @druzhinin-kirill