Skip to content

Commit 90a821a

Browse files
alambjonahgao
andauthored
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]>
1 parent d2625c3 commit 90a821a

File tree

3 files changed

+34
-11
lines changed

3 files changed

+34
-11
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@
1717
under the License.
1818
-->
1919

20-
See the Contributor Guide: https://arrow.apache.org/datafusion/ or the source under `docs/source/contributor-guide`
20+
See the [Contributor Guide](https://arrow.apache.org/datafusion/contributor-guide/index.html)

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ It lets you start quickly from a fully working engine, and then customize those
6262

6363
## Contributing to DataFusion
6464

65-
Please see the [developer’s guide] for contributing and [communication] for getting in touch with us.
65+
Please see the [contributor guide] and [communication] pages for more information.
6666

67-
[developer’s guide]: https://arrow.apache.org/datafusion/contributor-guide/index.html#developer-s-guide
67+
[contributor guide]: https://arrow.apache.org/datafusion/contributor-guide
6868
[communication]: https://arrow.apache.org/datafusion/contributor-guide/communication.html
6969

7070
## Crate features

docs/source/contributor-guide/index.md

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,40 @@
1919

2020
# Introduction
2121

22-
We welcome and encourage contributions of all kinds, such as:
22+
We welcome and encourage contributions of all kinds, from all levels, such as:
2323

24-
1. Tickets with issue reports of feature requests
25-
2. Documentation improvements
26-
3. Code, both PR and (especially) PR Review.
24+
1. Tickets with issue reports or feature requests
25+
2. Discussions
26+
3. Documentation improvements
27+
4. Code, both PR and (especially) PR Review.
2728

28-
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.
29+
In addition to submitting new PRs, we have a healthy tradition of community
30+
members reviewing each other's PRs. Doing so is a great way to help the
31+
community as well as get more familiar with Rust and the relevant codebases.
2932

30-
You can find a curated
31-
[good-first-issue](https://github.com/apache/arrow-datafusion/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
32-
list to help you get started.
33+
## Finding and Creating Issues to Work On
34+
35+
You can find a curated [good-first-issue] list to help you get started.
36+
37+
DataFusion is an open contribution project, and thus there is no particular
38+
project imposed deadline for completing any issue or any restriction on who can
39+
work on an issue, nor how many people can work on an issue at the same time.
40+
41+
Contributors drive the project forward based on their own priorities and
42+
interests and thus you are free to work on any issue that interests you.
43+
44+
If someone is already working on an issue that you want or need but hasn't
45+
been able to finish it yet, you should feel free to work on it as well. In
46+
general it is both polite and will help avoid unnecessary duplication of work if
47+
you leave a note on an issue when you start working on it.
48+
49+
If you plan to work on a new feature that doesn't have an existing ticket, it is
50+
a good idea to open a ticket to discuss the feature. Advanced discussion often
51+
helps avoid wasted effort by determining early if the feature is a good fit for
52+
DataFusion before too much time is invested. It also often helps to discuss your
53+
ideas with the community to get feedback on implementation.
54+
55+
[good-first-issue]: https://github.com/apache/arrow-datafusion/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
3356

3457
# Developer's guide
3558

0 commit comments

Comments
 (0)