Propose changes to OSS expectations #5584
Merged
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
github-actions
bot
added
content
|
|
||
| **Our goal is to review most new PRs within 7 days.** The first review will include some high-level comments about the implementation, including (at a high level) whether it’s something we think suitable to merge. Depending on the scope of the PR, the first review may include line-level code suggestions, or we may delay specific code review until the PR is more finalized / until we have more time. | ||
| **PRs go through two review steps.** First, we aim to respond with feedback on whether we think the implementation is appropriate from a product & usability standpoint. At this point, we will close PRs that we believe fall outside the scope of dbt Core, or which might lead to an inconsistent user experience. This is an important part of our role as maintainers; we're always open to hearing disagreement. If a PR passes this first review, we will queue it up for code review, at which point we aim to test it ourselves and provide thorough feedback within the next month. |
There was a problem hiding this comment.
Hiya @jtcohen6 this looks great. This is a non-blocker suggestion but it might be a good idea to share a PR example to guide the user - to give the user an idea of the review process and steps and what "good" looks like. I hope that's ok. Let me know what you think.
There was a problem hiding this comment.
@nataliefiann That's a good thought!
Some recent examples that I'll add:
- Fix configuration of turning test warnings into failures dbt-core#9347
- Better error message when trying to select a disabled model dbt-core#9863
My only hesitation is that these examples shouldn't be taken as templates of exactly what to do, because over time they'll get "stale" — as we change our review processes, our expectations for testing, etc.
There was a problem hiding this comment.
Hiya @jtcohen6 - this looks really good.
I've reviewed this for you and left two suggestions
- one being a non-blocker suggestion of possibly sharing a PR example to guide the user of the PR review process and steps
- the second being a slight tweak of on sentence to make it slightly clearer.
I've noticed you have Grace and Doug as additional reviewers. Everything looks good from a docs perspective. Let me know if you need me to approve and / or merge.
graciegoheen
approved these changes
May 31, 2024
dbeatty10
approved these changes
May 31, 2024
| @@ -51,7 +51,7 @@ An issue could be a bug you’ve identified while using the product or reading t | |||
|
|
|||
| ### Best practices for issues | |||
|
|
|||
| - Issues are **not** for support / troubleshooting / debugging help. Please [open a discussion on the dbt Community Forum](https://discourse.getdbt.com), so other future users can find and read proposed solutions. If you need help formulating your question, you can post in the `#advice-dbt-help` channel in the [dbt Community Slack](https://www.getdbt.com/community/). | |||
| - Issues are **not** for support / troubleshooting / debugging help. Please see [dbt support](https://docs.getdbt.com/docs/dbt-support) for more details and suggestions on how to get help. | |||
There was a problem hiding this comment.
Would this relative link work? Or does it need to be an absolute link?
Suggested change
| - Issues are **not** for support / troubleshooting / debugging help. Please see [dbt support](https://docs.getdbt.com/docs/dbt-support) for more details and suggestions on how to get help. | |
| - Issues are **not** for support / troubleshooting / debugging help. Please see [dbt support](/docs/dbt-support) for more details and suggestions on how to get help. |
|
|
||
| **What if I’m opening an issue in a smaller repository?** We’ve open sourced a number of software projects over the years; not all of them have the same activity or maintenance guarantees as `dbt-core`. Check to see if other recent issues have responses, or when the last commit was added to the `main` branch. | ||
| **What if I’m opening an issue in a different repository?** We have engineering teams dedicated to active maintainence of `dbt-core` and its component libraries (`dbt-common` + `dbt-adapters`), as well as several platform-specific adapters (`dbt-snowflake`, `dbt-bigquery`, `dbt-redshift`, `dbt-postgres`). We’ve open sourced a number of other software projects over the years, and the majority of them do not have the same activity or maintenance guarantees. Check to see if other recent issues have responses, or when the last commit was added to the `main` branch. |
There was a problem hiding this comment.
It might be helpful to be dense with hyperlinks here.
Adding links could look like this:
Suggested change
| **What if I’m opening an issue in a different repository?** We have engineering teams dedicated to active maintainence of `dbt-core` and its component libraries (`dbt-common` + `dbt-adapters`), as well as several platform-specific adapters (`dbt-snowflake`, `dbt-bigquery`, `dbt-redshift`, `dbt-postgres`). We’ve open sourced a number of other software projects over the years, and the majority of them do not have the same activity or maintenance guarantees. Check to see if other recent issues have responses, or when the last commit was added to the `main` branch. | |
| **What if I’m opening an issue in a different repository?** We have engineering teams dedicated to active maintainence of [`dbt-core`](https://github.com/dbt-labs/dbt-core) and its component libraries ([`dbt-common`](https://github.com/dbt-labs/dbt-common) + [`dbt-adapters`](https://github.com/dbt-labs/dbt-adapters)), as well as several platform-specific adapters ([`dbt-snowflake`](https://github.com/dbt-labs/dbt-snowflake), [`dbt-bigquery`](https://github.com/dbt-labs/dbt-bigquery), [`dbt-redshift`](https://github.com/dbt-labs/dbt-redshift), [`dbt-postgres`](https://github.com/dbt-labs/dbt-postgres)). We’ve open sourced a number of other software projects over the years, and the majority of them do not have the same activity or maintenance guarantees. Check to see if other recent issues have responses, or when the last commit was added to the `main` branch. |
|
Thanks for the review & suggestions @nataliefiann @graciegoheen @dbeatty10! I've pushed up changes, and I'm going to merge this as soon as CI passes. |
matthewshaver
added a commit
that referenced
this pull request
Dec 11, 2024
## What are you changing in this pull request and why? Follow-up to: - #5584 - https://www.youtube.com/watch?v=DC9sbZBYzpI - https://www.youtube.com/watch?v=I72yUtrmhbY Let's make sure our public expectations are aligned with our teams' commitments around responding to OSS discussions/issues and reviewing externally contributed PRs --------- Co-authored-by: graciegoheen <[email protected]> Co-authored-by: Doug Beatty <[email protected]> Co-authored-by: Matt Shaver <[email protected]>
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.
It's been two(?) years since I wrote these docs on "OSS Expectations," and in that time we've updated our approach to engaging with OSS issues & PRs. I'm proposing updates to reflect those changes.