Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-12-01 01:04:00 +00:00
Code Issues Releases Activity

docs: remove redundant settings in Contributing guide (#1326)

Browse Source 
Have removed some redundant settings in the CONTRIBUTING.md since
starship should be the only application using the `STARSHIP_LOG` env
var.
This commit is contained in:
Thomas O'Donnell 2020-06-14 22:02:24 +02:00 committed by GitHub
parent feac3d56ce
commit 4788092423
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -32,10 +32,10 @@ For example, to enable the trace logs, run the following:
```sh ```sh
# Run installed starship # Run installed starship
STARSHIP_LOG=starship=trace starship STARSHIP_LOG=trace starship
# Run with cargo # Run with cargo
STARSHIP_LOG=starship=trace cargo run STARSHIP_LOG=trace cargo run
``` ```
## Linting ## 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 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()`. Any tests that use `create_fixture_repo()` should remove the returned directory after usage with `remove_dir_all::remove_dir_all()`.