This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new 90a821a061 Docs: improve contributor guide to explain how to work with
tickets (#8999)
90a821a061 is described below
commit 90a821a061643763e9e7b2a36d4bbf275b6511f1
Author: Andrew Lamb <[email protected]>
AuthorDate: Mon Jan 29 15:34:34 2024 -0500
Docs: improve contributor guide to explain how to work with tickets (#8999)
* Docs: improve contributor guide to explain how to work with tickets
* Apply suggestions from code review
* Update docs/source/contributor-guide/index.md
Co-authored-by: Jonah Gao <[email protected]>
* fix extra link
* Update link on main README
---------
Co-authored-by: Jonah Gao <[email protected]>
---
CONTRIBUTING.md | 2 +-
README.md | 4 ++--
docs/source/contributor-guide/index.md | 39 +++++++++++++++++++++++++++-------
3 files changed, 34 insertions(+), 11 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 29a1a06923..6d5c5d1460 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -17,4 +17,4 @@
under the License.
-->
-See the Contributor Guide: https://arrow.apache.org/datafusion/ or the source
under `docs/source/contributor-guide`
+See the [Contributor
Guide](https://arrow.apache.org/datafusion/contributor-guide/index.html)
diff --git a/README.md b/README.md
index cb89aff4ae..232b252031 100644
--- a/README.md
+++ b/README.md
@@ -62,9 +62,9 @@ It lets you start quickly from a fully working engine, and
then customize those
## Contributing to DataFusion
-Please see the [developer’s guide] for contributing and [communication] for
getting in touch with us.
+Please see the [contributor guide] and [communication] pages for more
information.
-[developer’s guide]:
https://arrow.apache.org/datafusion/contributor-guide/index.html#developer-s-guide
+[contributor guide]: https://arrow.apache.org/datafusion/contributor-guide
[communication]:
https://arrow.apache.org/datafusion/contributor-guide/communication.html
## Crate features
diff --git a/docs/source/contributor-guide/index.md
b/docs/source/contributor-guide/index.md
index 11dcbd935a..748e100fb7 100644
--- a/docs/source/contributor-guide/index.md
+++ b/docs/source/contributor-guide/index.md
@@ -19,17 +19,40 @@
# Introduction
-We welcome and encourage contributions of all kinds, such as:
+We welcome and encourage contributions of all kinds, from all levels, such as:
-1. Tickets with issue reports of feature requests
-2. Documentation improvements
-3. Code, both PR and (especially) PR Review.
+1. Tickets with issue reports or feature requests
+2. Discussions
+3. Documentation improvements
+4. Code, both PR and (especially) PR Review.
-In addition to submitting new PRs, we have a healthy tradition of community
members reviewing each other's PRs. Doing so is a great way to help the
community as well as get more familiar with Rust and the relevant codebases.
+In addition to submitting new PRs, we have a healthy tradition of community
+members reviewing each other's PRs. Doing so is a great way to help the
+community as well as get more familiar with Rust and the relevant codebases.
-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.
+## Finding and Creating Issues to Work On
+
+You can find a curated [good-first-issue] list to help you get started.
+
+DataFusion is an open contribution project, and thus there is no particular
+project imposed deadline for completing any issue or any restriction on who can
+work on an issue, nor how many people can work on an issue at the same time.
+
+Contributors drive the project forward based on their own priorities and
+interests and thus you are free to work on any issue that interests you.
+
+If someone is already working on an issue that you want or need but hasn't
+been able to finish it yet, you should feel free to work on it as well. In
+general it is both polite and will help avoid unnecessary duplication of work
if
+you leave a note on an issue when you start working on it.
+
+If you plan to work on a new feature that doesn't have an existing ticket, it
is
+a good idea to open a ticket to discuss the feature. Advanced discussion often
+helps avoid wasted effort by determining early if the feature is a good fit for
+DataFusion before too much time is invested. It also often helps to discuss
your
+ideas with the community to get feedback on implementation.
+
+[good-first-issue]:
https://github.com/apache/arrow-datafusion/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
# Developer's guide
