blackmwk commented on code in PR #2779: URL: https://github.com/apache/iceberg-rust/pull/2779#discussion_r3585219163
########## README.md: ########## @@ -106,10 +106,31 @@ The Apache Iceberg Rust project is composed of the following components: The features that Iceberg Rust currently supports can be found [here](https://iceberg.apache.org/status/). +## Development + +Development tools and tasks are managed with [mise](https://mise.en.dev/). After installing mise, review the repository's root [`mise.toml`](mise.toml) and the Python subproject's [`mise.toml`](bindings/python/mise.toml). Trusting the monorepo root also trusts its listed subprojects. Then run: + +```shell +mise trust +mise install +mise run build +``` + +Common development commands include: + +```shell +mise run check # Run formatting, lint, and dependency checks +mise run unit-test # Run Rust unit and documentation tests +mise run test # Run all tests, including container-backed tests +``` + +The full test suite also requires Docker or Podman. See the [Contributing Guide](CONTRIBUTING.md) for complete setup instructions, Python binding tasks, and troubleshooting. + ## Supported Rust Version -Iceberg Rust is built and tested with stable rust, and will keep a rolling MSRV (minimum supported rust version). -At least three months from latest rust release is supported. MSRV is updated when we release iceberg-rust. +Iceberg Rust keeps a rolling MSRV (minimum supported Rust version), currently Rust 1.94. The MSRV is updated when we release iceberg-rust and is at least three months behind the latest Rust release. Review Comment: I think putting the exact version in README.md makes our user easier to follow, otherwise we need to ask user to check mise.toml. We could update README.md everytime we upgrade msrv. -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
