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

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

Merged
merged 2 commits into from
Dec 13, 2024

Conversation

dbeatty10
Copy link
Contributor

resolves #242

Problem

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

  • Description & motivation

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

  • Problem
  • Solution

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

  • This code is associated with an issue which has been triaged and accepted for development.
  • I have read the contributing guide and understand what's expected of me
  • [N/A] I have verified that these changes work locally
  • [N/A] I have updated the README.md (if applicable)
  • [N/A] I have added tests & descriptions to my models (and macros if applicable)

@dbeatty10 dbeatty10 marked this pull request as ready for review December 13, 2024 20:48
@dosubot dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Dec 13, 2024
@dbeatty10 dbeatty10 merged commit 70b4ecb into main Dec 13, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Align the PR description with dbt-core, dbt-adapters, etc.
1 participant