GH-48951: [Docs] Add documentation relating to AI tooling #48952
+42
−1
Conversation
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
github-actions
bot
added
Component: Documentation
awaiting committer review
Member
Author
|
@github-actions crossbow submit preview-docs |
|
Revision: 3869b14 Submitted crossbow builds: ursacomputing/crossbow @ actions-e3261c98f2
|
alamb
reviewed
Jan 23, 2026
Contributor
alamb
left a comment
alamb
left a comment
There was a problem hiding this comment.
looks good to me - thanks @thisisnic -- I left some tiny wording suggestions
docs/source/developers/overview.rst
Outdated
| We are not opposed to the use of AI tools in generating PRs, but recommend | ||
| the following: | ||
|
|
||
| * Only take on a PR if you are able to debug and own the changes yourself - |
Contributor
There was a problem hiding this comment.
instead of "take on" maybe "submit' might better capture what you are trying to do
github-actions
bot
added
awaiting changes
wgtmac
reviewed
Jan 23, 2026
| * Break down large PRs into smaller ones to make review easier | ||
|
|
||
| PR authors are also responsible for disclosing any copyrighted materials in | ||
| submitted contributions. See the `ASF's guidance on AI-generated code |
Member
There was a problem hiding this comment.
Do we need to modify the PR template about this?
Member
Author
There was a problem hiding this comment.
I think we're good, as we already have a link to this page in the template already, and it covers quite a few other topics too.
Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
thisisnic
commented
Jan 23, 2026
github-actions
bot
added
awaiting change review
github-actions
bot
added
awaiting review
rok
reviewed
Jan 23, 2026
Co-authored-by: Rok Mihevc <rok@mihevc.org>
github-actions
bot
added
awaiting change review
rok
approved these changes
Jan 23, 2026
github-actions
bot
added
awaiting merge
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Rationale for this change
Add guidance re AI tooling
What changes are included in this PR?
Updates to main docs and links to it from new contributor's guide
Are these changes tested?
No but I'll built the docs
Are there any user-facing changes?
Just docs
🤖 Changes generated using Claude Code - I took the discussion from the mailing list, asked it to add the original text and then apply suggested changes one at a time, made a few of my own tweaks, and then instructed it to edit things down a bit for clarity and conciseness.