add notes on debugging requests - closes #47

carrot · Dec 11, 2015 · d54cf15 · d54cf15
1 parent 52a44b3
commit d54cf15
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/contributing.md b/contributing.md
@@ -36,10 +36,13 @@ $ make lint
 
 To lint the source and run the tests:
 
-```
+```bash
 $ npm test
+# or, for optional request logging:
+$ NODE_DEBUG=request npm test
 ```
 
+
 To create a coverage report:
 
 ```

diff --git a/readme.md b/readme.md
@@ -182,6 +182,16 @@ roots-contentful also provides a convenient view helper called `asset` that allo
   img(src!= asset(post.image, {w: 100, h: 100, q: 50}))
 ```
 
+### Debugging Requests
+
+This extension makes network requests. If you need to log requests for debugging, set your `NODE_DEBUG` environment variable to `request`.
+
+For example, in a `roots compile` command:
+
+```
+$ NODE_DEBUG=request roots compile --verbose
+```
+
 ### License & Contributing
 
 - Details on the license [can be found here](license.md)