improved documentation and bug issue template

This commit is contained in:
Riccardo Ferretti
2020-11-29 13:18:21 +01:00
parent 4e624d5cf9
commit 5af17c58c0
2 changed files with 24 additions and 5 deletions

View File

@@ -4,8 +4,9 @@ about: Create a report to help us be foamier
labels: bug
---
<!-- Check in the VSCode extension tab. -->
- Foam version:
- Foam version: <!-- Check in the VSCode extension tab. -->
- Platform: Windows | Mac | Linux
- Issue occur on the [foam template](https://github.com/foambubble/foam-template) repo: Yes | No
**Summary**
<!-- A clear and concise description of what the bug is.-->
@@ -14,8 +15,9 @@ labels: bug
1.
2.
Does this issue occur on the [foam template](https://github.com/foambubble/foam-template) repo? Yes/No
**Additional information**
<!-- Add any other context about the problem here. -->
*Feel free to attach a screenshot and/or include a zip with a minimal repo to reproduce the issue*
Feel free to attach any of the following that might help with debugging the issue:
- screenshots
- a zip with a minimal repo to reproduce the issue
- the Foam log in VsCode (see [instructions](https://github.com/foambubble/foam/blob/master/docs/foam-logging-in-vscode.md))

View File

@@ -0,0 +1,17 @@
# Foam logging in VsCode
## Find the Foam log
The Foam log can be found in the `Output` tab.
1. To show the tab, click on `View > Output`.
2. In the dropdown on the right of the tab, select `Foam`.
## Change the default logging level
1. Open workspace settings (`cmd+,`, or execute the `Preferences: Open Workspace Settings` command)
2. Look for the entry `Foam > Logging: Level`
Set to debug when reporting an issue
## Change the log level for the session
Execute the command `Foam: Set log level`.