blaginin commented on code in PR #13672: URL: https://github.com/apache/datafusion/pull/13672#discussion_r1984960392
########## datafusion-cli/CONTRIBUTING.md: ########## @@ -0,0 +1,72 @@ +<!--- + 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. +--> + +# Development instructions + +## Running Tests + +Tests can be run using `cargo` + +```shell +cargo test +``` + +## Snapshot testing + +To test CLI output, [Insta](https://github.com/mitsuhiko/insta) is used for snapshot testing. Snapshots are generated +and compared on each test run. If the output changes, tests will fail. +To review the changes, you can use Insta CLI: + +```shell +cargo install cargo-insta +cargo insta review Review Comment: sure! there's also an input data in the snap file, i can work on making them more readable in the future if you want <img width="1103" alt="RustRover-EAP 2025-03-07 12 13 58" src="https://github.com/user-attachments/assets/b5d8204d-3321-460b-89e5-e75719d872bc"; /> -- 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]
