summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorThomas O'Donnell <andytom@users.noreply.github.com>2020-06-14 22:02:24 +0200
committerGitHub <noreply@github.com>2020-06-14 16:02:24 -0400
commit4788092423fd42387b49f60d2a2d89db0deb6bab (patch)
tree250633fd14721e99706acb4dccf4b1af3bc66d4c /CONTRIBUTING.md
parentfeac3d56ce7d9e530cd7f4d66059ac42645b0834 (diff)
docs: remove redundant settings in Contributing guide (#1326)
Have removed some redundant settings in the CONTRIBUTING.md since starship should be the only application using the `STARSHIP_LOG` env var.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c5b680ed5..dd470e8f6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -32,10 +32,10 @@ For example, to enable the trace logs, run the following:
```sh
# Run installed starship
-STARSHIP_LOG=starship=trace starship
+STARSHIP_LOG=trace starship
# Run with cargo
-STARSHIP_LOG=starship=trace cargo run
+STARSHIP_LOG=trace cargo run
```
## Linting
@@ -84,7 +84,7 @@ For tests that depend on having preexisting state, whatever needed state will ha
Any tests that depend on File I/O should use [`sync_all()`](https://doc.rust-lang.org/std/fs/struct.File.html#method.sync_all) when creating files or after writing to files.
-Any tests that use `tempfile::tempdir` should take care to call `dir.close()` after usage to ensure the lifecycle of the directory can be reasoned about.
+Any tests that use `tempfile::tempdir` should take care to call `dir.close()` after usage to ensure the lifecycle of the directory can be reasoned about.
Any tests that use `create_fixture_repo()` should remove the returned directory after usage with `remove_dir_all::remove_dir_all()`.