Welcome! Thank you for contributing to the SDF Workspace Evaluator. The goal with this library is to provide a set of common reports around any SDF workspace that helps teams promote good data engineering practices.
There are various ways you can contribute:
- Add a new report
- Update an existing report
- Expanding documentation
Most people want to add a new report. For steps on how to do this, please read the How to Add a New Report section below.
Reports are located under sections in the /reports directory. Each report has corresponding documentation in that section's markdown file.
Each SQL file contains one report, written in Trino Dialect SQL.
These reports are designed to be relevant, easy to use, and appplicable to a wide range of organizations. They should allow for fast at-a-glance understanding of the data warehouse in which you are working.
When designing a report to contribute, optimize for
- Utility - A report should display useful at-a-glance information
- Generality - A report should be generic & applicable to many types of organizations, and practices.
- Performance - A report should be fast to execute.