summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authoranouar kappitou <anoirkapp@gmail.com>2020-06-14 19:22:34 +0100
committerGitHub <noreply@github.com>2020-06-14 20:22:34 +0200
commitfeac3d56ce7d9e530cd7f4d66059ac42645b0834 (patch)
tree99c9af875fdf52aad4d92191f458f7d2f616140b /CONTRIBUTING.md
parent055986e2b1910fe7ed65dc1f058eaa2683046113 (diff)
fix: replacing default RUST_LOG environement variable with starship specific one, to prevent interlacing (#1280)
Co-authored-by: Kappitou Anouar <anourkappitou@gmail.com>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 69b74320e..c5b680ed5 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -27,15 +27,15 @@ Any styling that is applied to a module is inherited by its segments. Module pre
## Logging
Debug logging in starship is done with [pretty_env_logger](https://crates.io/crates/pretty_env_logger).
-To run starship with debug logs, set the `RUST_LOG` environment variable to the log level needed.
+To run starship with debug logs, set the `STARSHIP_LOG` environment variable to the log level needed.
For example, to enable the trace logs, run the following:
```sh
# Run installed starship
-RUST_LOG=starship=trace starship
+STARSHIP_LOG=starship=trace starship
# Run with cargo
-RUST_LOG=starship=trace cargo run
+STARSHIP_LOG=starship=trace cargo run
```
## Linting
@@ -118,4 +118,4 @@ This is our preferred process for opening a PR on GitHub:
4. When your changes are ready for review, push your branch: `git push origin my-feature-branch`
5. Create a pull request from your branch to `starship/master`
6. No need to assign the pull request to anyone, we'll review it when we can
-7. When the changes have been reviewed and approved, someone will squash and merge for you \ No newline at end of file
+7. When the changes have been reviewed and approved, someone will squash and merge for you