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

Docs: Update PR workflow documentation #10532

Merged
merged 10 commits into from
May 22, 2024
Merged

Docs: Update PR workflow documentation #10532

merged 10 commits into from
May 22, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented May 15, 2024

Which issue does this PR close?

Part of #7013

Rationale for this change

I realize I often wait some time between approve and merge which can be confusing and is not really documented. Most recently this came up with @shanretoo on #10476 at #10476 (comment)

What changes are included in this PR?

Clarify documentation explaining the PR cycle

Are these changes tested?

Are there any user-facing changes?

@alamb alamb added the development-process Related to development process of DataFusion label May 15, 2024
@alamb alamb changed the title Minor: Update PR workflow documentation Docs: Update PR workflow documentation May 15, 2024
@github-actions github-actions bot removed the development-process Related to development process of DataFusion label May 15, 2024
Copy link
Contributor

@comphead comphead left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, thanks @alamb
I'm thinking should describe a draft status usage as well?

My vision the PR should be in draft in some scenarios:

  • Waiting too long(how long?) for the author response on feedbacks
  • if the PR is POC, WIP, or other conditions when PR is not really to be reviewed

docs/source/contributor-guide/index.md Outdated Show resolved Hide resolved
docs/source/contributor-guide/index.md Outdated Show resolved Hide resolved
docs/source/contributor-guide/index.md Outdated Show resolved Hide resolved
@viirya
Copy link
Member

viirya commented May 17, 2024

I realize I often wait some time between approve and merge which can be confusing and is not really documented. Most recently this came up with @shanretoo on #10476 at #10476 (comment)

Took a look. I think this only happens in rare case? The contributor is not only a new contributor to DataFusion but looks like has not participated in open source before (since the GitHub account is created recently).

For such cases, I wonder if they will look at the document added here firstly. 😄

@alamb
Copy link
Contributor Author

alamb commented May 20, 2024

I plan to incorporate the feedback on this PR, I just haven't had a chance yet. I hope to do so over the next few days

@alamb
Copy link
Contributor Author

alamb commented May 22, 2024

For such cases, I wonder if they will look at the document added here firstly. 😄

This is an excellent point @viirya -- I realize some people may not read the doc, but at least now we will have a place to point them

@alamb
Copy link
Contributor Author

alamb commented May 22, 2024

I'm thinking should describe a draft status usage as well?

@comphead -- in so far that we know how we use the draft status, that might be helpful. However, I am not sure it is consistently used enough to explain it.

@alamb
Copy link
Contributor Author

alamb commented May 22, 2024

I also added two links to github filters I use to find PRs waiting on review and PRs that are approved waiting on merge:

Screenshot 2024-05-22 at 6 08 54 AM

Thank you all for the comments. I'll merge this one in and we can address additional comments / suggestions as follow on PRs

@alamb alamb merged commit d7e642a into apache:main May 22, 2024
4 checks passed
@alamb alamb added documentation Improvements or additions to documentation development-process Related to development process of DataFusion labels May 22, 2024
findepi pushed a commit to findepi/datafusion that referenced this pull request Jul 16, 2024
* Minor: Update PR workflow documentation

* prettier

* Clarify leaving PRs open

* Update docs/source/contributor-guide/index.md

Co-authored-by: Oleks V <[email protected]>

* Update docs/source/contributor-guide/index.md

Co-authored-by: Oleks V <[email protected]>

* prettier

* pretty

---------

Co-authored-by: Oleks V <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
development-process Related to development process of DataFusion documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants