Jefffrey commented on code in PR #11400: URL: https://github.com/apache/arrow-rs/pull/11400#discussion_r4197074375
########## AGENTS.md: ########## @@ -0,0 +1,74 @@ +<!--- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# 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 + +# Test each affected crate (replace arrow with the crate you changed) +cargo test -p arrow Review Comment: it might just be better to run the whole suite 🤔 `cargo run` because we have crates depending on each other, a change to one crate doesnt mean its isolated to that crate ########## AGENTS.md: ########## @@ -0,0 +1,74 @@ +<!--- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# 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 + +# Test each affected crate (replace arrow with the crate you changed) +cargo test -p arrow +``` + +See the [testing](CONTRIBUTING.md#running-the-tests), [formatting](CONTRIBUTING.md#code-formatting), [Clippy](CONTRIBUTING.md#clippy-lints), and [spelling](CONTRIBUTING.md#spell-checking) guidance for details. + +## CI and Additional Checks + +Documentation-only PRs still run the `dev`, `rust`, and `docs` workflows. Code +changes may trigger additional workflows according to their `pull_request.paths` +filters. Check the [workflow overview](.github/workflows/README.md) and the +[individual workflows](.github/workflows/) for current checks and feature +combinations. + +For performance work, see [benchmarks](CONTRIBUTING.md#performance-improvements). For memory-safety checks, see [Miri](CONTRIBUTING.md#miri). +For public API changes, see [breaking changes](CONTRIBUTING.md#breaking-changes). + +## AI-Assisted Contributions + +Review, understand, and own all generated changes. Follow repository style, Review Comment: im not sure about putting this part agents; this part is meant to be read and understood by the human, so asking the LLM to review, understand and own the change feels like we're missing the point ########## AGENTS.md: ########## @@ -0,0 +1,74 @@ +<!--- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# 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 + +# Test each affected crate (replace arrow with the crate you changed) +cargo test -p arrow +``` + +See the [testing](CONTRIBUTING.md#running-the-tests), [formatting](CONTRIBUTING.md#code-formatting), [Clippy](CONTRIBUTING.md#clippy-lints), and [spelling](CONTRIBUTING.md#spell-checking) guidance for details. + +## CI and Additional Checks + +Documentation-only PRs still run the `dev`, `rust`, and `docs` workflows. Code +changes may trigger additional workflows according to their `pull_request.paths` +filters. Check the [workflow overview](.github/workflows/README.md) and the +[individual workflows](.github/workflows/) for current checks and feature +combinations. Review Comment: is there value to having this here? -- 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]
