sdf-jkl commented on code in PR #11400: URL: https://github.com/apache/arrow-rs/pull/11400#discussion_r4221608449
########## AGENTS.md: ########## @@ -0,0 +1,43 @@ +# Agent Guidelines for Apache Arrow-rs + +This file is an entry point. Follow the detailed guidance in +[CONTRIBUTING.md](CONTRIBUTING.md) and the documentation for the crates you change. + +## Developer Documentation + +- [Repository overview and crate list](README.md#repository-structure) +- Crate READMEs: [Arrow](arrow/README.md), [Parquet](parquet/README.md), + [Arrow Flight](arrow-flight/README.md), and the README for each affected crate +- [Contributor guide](CONTRIBUTING.md) +- [Pull request template](.github/pull_request_template.md) + +## Setup and Validation + +Initialize test data before running tests or examples: + +```bash +git submodule update --init +``` + +Run the checks relevant to your change from the repository root: + +```bash +# Check Rust formatting and lints for code changes +cargo +stable fmt --all -- --check +cargo clippy --workspace --all-targets --all-features -- -D warnings + +# Check spelling, including documentation changes +# If typos is not installed, run: cargo install typos-cli +typos --config typos.toml + +# Run the full workspace test suite for code changes +cargo test --workspace Review Comment: This seems to already be covered by https://github.com/apache/arrow-rs/blob/main/CONTRIBUTING.md#git-submodules -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
