GH-50341: [C++] Add AGENTS.md to C++ dir#50365
Closed
AdvancedUno wants to merge 1 commit into
Closed
Conversation
|
|
github-actions
Bot
added
Component: C++
Component: Documentation
awaiting review
Member
|
I'm going to close this as it's going to be better if someone with experience of working on Arrow C++ does this, but if you're looking for somewhere to get involved, there are loads of tickets marked "Needs Champion" here that we'd love contributions for! https://github.com/apache/arrow/issues?q=state%3Aopen%20label%3A%22Status%3A%20needs%20champion%22 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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
The Arrow C++ library is the core of the monorepo that many language bindings depend on, but there is no AI-agent-oriented development guide for the
cpp/directory. This adds one, mirroring the proposedr/AGENTS.md(#50343), giving agents and new contributors a concise, verified entry point for building, testing, and contributing to Arrow C++.What changes are included in this PR?
Adds a single new documentation file,
cpp/AGENTS.md, covering project overview, AI disclosure, generated files, building (CMake presets), testing (GoogleTest/ctest), code style and linting (clang-format/cpplint using pre-commit), the file-structure layout, and the PR/git workflow.Are these changes tested?
No, just document
Are there any user-facing changes?
No