docs: add DEBUG=corepack logging instructions

nodejs · Jan 21, 2025 · 06c29ac · 06c29ac
1 parent 2a04e7c
commit 06c29ac
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -9,7 +9,8 @@ If you want to build Corepack yourself, you can build the project like this:
 
 The `dist/` directory now contains the corepack build and the shims.
 Call `node ./dist/corepack --help` and behold.
-You can also run the tests with `yarn test`.
+
+You can also run the tests with `yarn test`. (Do not set the environment variable `DEBUG=corepack` when running tests. The additional debug logging causes tests to fail.)
 
 # Adding a new package manager
 

diff --git a/README.md b/README.md
@@ -302,6 +302,8 @@ same major line. Should you need to upgrade to a new major, use an explicit
 
 ## Troubleshooting
 
+The environment variable `DEBUG` can be set to `corepack` to enable additional debug logging.
+
 ### Networking
 
 There are a wide variety of networking issues that can occur while running