You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "alamb (via GitHub)" <gi...@apache.org> on 2024/01/25 19:12:53 UTC
[PR] Docs: improve contributor guide to explain how to work with tickets [arrow-datafusion]
alamb opened a new pull request, #8999:
URL: https://github.com/apache/arrow-datafusion/pull/8999
## Which issue does this PR close?
Part of #7013
## Rationale for this change
Recently the question of who is / could be working on what ticket came up in discussions. For example"
* https://github.com/apache/arrow-datafusion/issues/8969#issuecomment-1910063746 from @Lordworms about what tickets were available
* Where @Tangruilin and @simicd ended up working on the same ticket: https://github.com/apache/arrow-datafusion/pull/8967
I think it would be good to clarify the contributing guide in this case
## What changes are included in this PR?
1. Update the contributing guide to explain the existing decorum: work on what you want, but it is polite to announce on tickets and file new tickets for new behavior
## Are these changes tested?
Docs only
<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code
If tests are not included in your PR, please explain why (for example, are they covered by existing tests)?
-->
## Are there any user-facing changes?
<!--
If there are user-facing changes then we may require documentation to be updated before approving the PR.
-->
<!--
If there are any breaking changes to public APIs, please add the `api change` label.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docs: improve contributor guide to explain how to work with tickets [arrow-datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #8999:
URL: https://github.com/apache/arrow-datafusion/pull/8999#issuecomment-1915395425
> Thanks @alamb would be nice to have a link to contribution.md from the top level page in
>
> https://github.com/apache/arrow-datafusion#contributing-to-datafusion section
Excellent call -- done in [94bbca7](https://github.com/apache/arrow-datafusion/pull/8999/commits/94bbca7f93d013d6e5336587b6b4547934544af7)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docs: improve contributor guide to explain how to work with tickets [arrow-datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb merged PR #8999:
URL: https://github.com/apache/arrow-datafusion/pull/8999
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docs: improve contributor guide to explain how to work with tickets [arrow-datafusion]
Posted by "jonahgao (via GitHub)" <gi...@apache.org>.
jonahgao commented on code in PR #8999:
URL: https://github.com/apache/arrow-datafusion/pull/8999#discussion_r1468316237
##########
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 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.
-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)
Review Comment:
```suggestion
```
Moved.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docs: improve contributor guide to explain how to work with tickets [arrow-datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #8999:
URL: https://github.com/apache/arrow-datafusion/pull/8999#discussion_r1466817553
##########
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
Review Comment:
```suggestion
If someone is already working on an issue that you want or need but hasn't
```
##########
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
Review Comment:
```suggestion
helps avoid wasted effort by determining early if the feature is a good fit for
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docs: improve contributor guide to explain how to work with tickets [arrow-datafusion]
Posted by "simicd (via GitHub)" <gi...@apache.org>.
simicd commented on PR #8999:
URL: https://github.com/apache/arrow-datafusion/pull/8999#issuecomment-1910848324
Thanks for expanding the contributor guide @alamb, very clear!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docs: improve contributor guide to explain how to work with tickets [arrow-datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #8999:
URL: https://github.com/apache/arrow-datafusion/pull/8999#discussion_r1468435827
##########
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.
Review Comment:
Good call -- thank you @jonahgao
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docs: improve contributor guide to explain how to work with tickets [arrow-datafusion]
Posted by "jonahgao (via GitHub)" <gi...@apache.org>.
jonahgao commented on code in PR #8999:
URL: https://github.com/apache/arrow-datafusion/pull/8999#discussion_r1468316093
##########
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.
Review Comment:
```suggestion
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.
```
How about moving the link over here? It previously displayed as:
> <img width="400" alt="截屏2024-01-27 11 57 53" src="https://github.com/apache/arrow-datafusion/assets/26053282/061499e6-5bbd-4a75-8e44-baa702716a1d">
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org