From fd543f51aec1d4f95f0874ef6e442fc261dae184 Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Thu, 25 Jan 2024 14:10:26 -0500 Subject: [PATCH 1/5] Docs: improve contributor guide to explain how to work with tickets --- CONTRIBUTING.md | 2 +- docs/source/contributor-guide/index.md | 37 +++++++++++++++++++++----- 2 files changed, 31 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 29a1a0692367..6d5c5d1460da 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/docs/source/contributor-guide/index.md b/docs/source/contributor-guide/index.md index 11dcbd935a02..fddbe502e192 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. + +## 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 on 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 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. -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. # Developer's guide From 2884eac1966318cb5af38620ffcc4bcc926ef249 Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Thu, 25 Jan 2024 14:17:25 -0500 Subject: [PATCH 2/5] Apply suggestions from code review --- docs/source/contributor-guide/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/contributor-guide/index.md b/docs/source/contributor-guide/index.md index fddbe502e192..7b15bb4338a8 100644 --- a/docs/source/contributor-guide/index.md +++ b/docs/source/contributor-guide/index.md @@ -41,14 +41,14 @@ 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 on but hasn't +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 wasted effort by determining early if the feature is a good fit for +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. From 441d5f47544b25cc390bd4aae1f9b52f9dd180ca Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Sat, 27 Jan 2024 05:07:55 -0500 Subject: [PATCH 3/5] Update docs/source/contributor-guide/index.md Co-authored-by: Jonah Gao --- docs/source/contributor-guide/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/contributor-guide/index.md b/docs/source/contributor-guide/index.md index 7b15bb4338a8..aab9f8de57b7 100644 --- a/docs/source/contributor-guide/index.md +++ b/docs/source/contributor-guide/index.md @@ -32,7 +32,7 @@ community as well as get more familiar with Rust and the relevant codebases. ## Finding and Creating Issues to Work On -You can find a curated [good-first-issue] list to help you get started. +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. 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 From b8e280b29b880a970f518ffff26cc3d6b9aaab8d Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Sat, 27 Jan 2024 05:10:08 -0500 Subject: [PATCH 4/5] fix extra link --- docs/source/contributor-guide/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/contributor-guide/index.md b/docs/source/contributor-guide/index.md index aab9f8de57b7..748e100fb726 100644 --- a/docs/source/contributor-guide/index.md +++ b/docs/source/contributor-guide/index.md @@ -32,7 +32,7 @@ community as well as get more familiar with Rust and the relevant codebases. ## Finding and Creating Issues to Work On -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. +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 @@ -52,7 +52,7 @@ 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) +[good-first-issue]: https://github.com/apache/arrow-datafusion/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 # Developer's guide From 94bbca7f93d013d6e5336587b6b4547934544af7 Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Mon, 29 Jan 2024 14:15:49 -0500 Subject: [PATCH 5/5] Update link on main README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cb89aff4aec7..232b252031d9 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