This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git
The following commit(s) were added to refs/heads/master by this push:
new 22dea5593 Add Pull Request guidelines to contributor guide (#3985)
22dea5593 is described below
commit 22dea55937bf890630e8fbddb8047a27ae3f8d14
Author: Andrew Lamb <[email protected]>
AuthorDate: Mon Oct 31 09:49:14 2022 -0400
Add Pull Request guidelines to contributor guide (#3985)
* Add Pull Request guidelines to contributor guide
* prettier
---
docs/source/contributor-guide/communication.md | 2 +-
docs/source/contributor-guide/index.md | 21 ++++++++++++++++++++-
2 files changed, 21 insertions(+), 2 deletions(-)
diff --git a/docs/source/contributor-guide/communication.md
b/docs/source/contributor-guide/communication.md
index cab4305f6..11e0e4e0f 100644
--- a/docs/source/contributor-guide/communication.md
+++ b/docs/source/contributor-guide/communication.md
@@ -69,6 +69,6 @@ The goals of these calls are:
1. Help "put a face to the name" of some of other contributors we are working
with
2. Discuss / synchronize on the goals and major initiatives from different
stakeholders to identify areas where more alignment is needed
-No decisions are made on the call and anything of substance will be discussed
on this mailing list or in github issues / google docs.
+No decisions are made on the call and anything of substance will be discussed
on the mailing list or in github issues / google docs.
We will send a summary of all sync ups to the [email protected] mailing
list.
diff --git a/docs/source/contributor-guide/index.md
b/docs/source/contributor-guide/index.md
index 30ba92eef..77ef01bc0 100644
--- a/docs/source/contributor-guide/index.md
+++ b/docs/source/contributor-guide/index.md
@@ -31,6 +31,25 @@ You can find a curated
[good-first-issue](https://github.com/apache/arrow-datafusion/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
list to help you get started.
+# Pull Requests
+
+We welcome pull requests (PRs) from anyone from the community.
+
+DataFusion is a very active fast-moving project and we try to review and merge
PRs quickly to keep the review backlog down and the pace up. After review and
approval, one of the [many people with commit
access](https://arrow.apache.org/committers/) will merge your PR.
+
+Review bandwidth is currently our most limited resource, and we highly
encourage reviews by the broader community. If you are waiting for your PR to
be reviewed, consider helping review other PRs that are waiting. Such review
both helps the reviewer to learn the codebase and become more expert, as well
as helps identify issues in the PR (such as lack of test coverage), that can be
addressed and make future reviews faster and more efficient.
+
+## Merging PRs
+
+Since we are a worldwide community, we have contributors in many timezones who
review and comment. To ensure anyone who wishes has an opportunity to review a
PR, our committers try to ensure that at least 24 hours passes between when a
"major" PR is approved and when it is merged.
+
+A "major" PR means there is a substantial change in design or a change in the
API. Committers apply their best judgment to determine what constitutes a
substantial change. A "minor" PR might be merged without a 24 hour delay, again
subject to the judgment of the committer. Examples of potential "minor" PRs are:
+
+1. Documentation improvements/additions
+2. Small bug fixes
+3. Non-controversial build-related changes (clippy, version upgrades etc.)
+4. Smaller non-controversial feature additions
+
# Developer's guide
This section describes how you can get started at developing DataFusion.
@@ -259,7 +278,7 @@ can be displayed. For example, the following command
creates a
dot -Tpdf < /tmp/plan.dot > /tmp/plan.pdf
```
-## Specification
+## Specifications
We formalize DataFusion semantics and behaviors through specification
documents. These specifications are useful to be used as references to help
