dbt-labs / dbt-utils

Utility functions for dbt projects.
https://hub.getdbt.com/dbt-labs/dbt_utils/latest/
Apache License 2.0
1.34k stars 491 forks source link

Align the PR description with dbt-core, dbt-adapters, etc. #911

Closed dbeatty10 closed 4 months ago

dbeatty10 commented 4 months ago

resolves #910

Problem

The PR template of dbt-utils has a single section for the main body of the description:

But dbt-core, dbt-adapters, etc. have two sections:

The latter allows the contributor to separate the design decisions of the implementation from the problem that it is trying to solve. This makes it easier for the contributor to write the PR description. It also makes it easier for others to read (code reviewers, users, etc.)

Solution

Adopt the standard established by dbt-core, dbt-adapters, etc in order to make it easier to read/write and also for those working across repos.

Checklist