-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Docs: improve contributor guide to explain how to work with tickets #8999
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
fd543f5
Docs: improve contributor guide to explain how to work with tickets
alamb 2884eac
Apply suggestions from code review
alamb 441d5f4
Update docs/source/contributor-guide/index.md
alamb 82f0481
Merge remote-tracking branch 'apache/main' into alamb/update_contribu…
alamb b8e280b
fix extra link
alamb 94bbca7
Update link on main README
alamb b91a289
Merge remote-tracking branch 'apache/main' into alamb/update_contribu…
alamb File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||
---|---|---|---|---|
|
@@ -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 | ||||
alamb marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
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 | ||||
alamb marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
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) | ||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Moved. |
||||
list to help you get started. | ||||
|
||||
# Developer's guide | ||||
|
||||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.