Align the PR description with dbt-core, dbt-adapters, etc. #911
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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