From 879e2d022384bb9685b5efafe75d6f8f0b9c9672 Mon Sep 17 00:00:00 2001 From: Linda_pp Date: Thu, 19 Oct 2023 15:23:32 +0900 Subject: [PATCH] consider ratatui usage in contribution guide --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2c0f7e7..38bf3b7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,8 @@ For reporting a bug, please make sure your report includes the following points. - Environment - Your terminal - Rust version - - `tui` crate version + - `tui` or `ratatui` crate version + - Enabled features of `tui-textarea` crate An example of bug report: https://github.com/rhysd/tui-textarea/issues/1 @@ -33,7 +34,7 @@ cargo fmt -- --check ``` If you use [cargo-watch][], `cargo watch-check` and `cargo watch-test` aliases are useful to run checks/tests automatically -on writing to a file. +on files being changed. ## Print debugging @@ -54,7 +55,7 @@ cargo run --example minimal 2>debug.txt ``` Then the debug prints are output to the `debug.txt` file. If timing is important or you want to see the output in real-time, -printing the file content with `tail` command would be useful. +it would be useful to monitor the file content with `tail` command in another terminal window. ```sh # In a terminal, reproduce the issue