Skip to content

Commit a5674d9

Browse files
committed
Revamp debugging section
- Most people leave the logs out so add a section for them in the issue template. - Remove the VS Code logs because those get sent to stdout now and will show up in our logs. - Separate browser console and network.
1 parent 4fd39b2 commit a5674d9

File tree

2 files changed

+31
-6
lines changed

2 files changed

+31
-6
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

+29-4
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,14 @@ assignees: ""
1010
1111
Hi there! 👋
1212
13-
Thanks for reporting a bug. Please see https://github.com/cdr/code-server/blob/main/docs/FAQ.md#how-do-i-debug-issues-with-code-server and include any logging information relevant to the issue.
14-
15-
Please search for existing issues before filing, as they may contain additional information about the problem and descriptions of workarounds. Provide as much information as you can, so that we can reproduce the issue. Otherwise, we may not be able to help diagnose the problem, and may close the issue as unreproducible or incomplete. For visual defects, please include screenshots to help us understand the issue.
13+
Thanks for reporting a bug.
14+
15+
Please search for existing issues before filing, as they may contain additional
16+
information about the problem and descriptions of workarounds. Provide as much
17+
information as you can, so that we can reproduce the issue. Otherwise, we may
18+
not be able to help diagnose the problem, and may close the issue as
19+
unreproducible or incomplete. For visual defects, please include screenshots to
20+
help us understand the issue.
1621
-->
1722

1823
## OS/Web Information
@@ -37,9 +42,29 @@ Please search for existing issues before filing, as they may contain additional
3742

3843
<!-- What actually happens? -->
3944

45+
## Logs
46+
47+
<!--
48+
First run code-server with at least debug logging (or trace to be really
49+
thorough) by setting the --log flag or the LOG_LEVEL environment variable. -vvv
50+
and --verbose are aliases for --log trace. For example:
51+
52+
code-server --log debug
53+
54+
Once this is done, replicate the issue you're having then collect logging
55+
information from the following places:
56+
57+
1. The most recent files from ~/.local/share/code-server/coder-logs.
58+
2. The browser console.
59+
3. The browser network tab.
60+
61+
Additionally, collecting core dumps (you may need to enable them first) if
62+
code-server crashes can be helpful.
63+
-->
64+
4065
## Screenshot
4166

42-
<!-- Ideally provide a screenshot, gif, video or screenrecording -->
67+
<!-- Ideally provide a screenshot, gif, video or screen recording. -->
4368

4469
## Notes
4570

docs/FAQ.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -330,8 +330,8 @@ Once this is done, replicate the issue you're having then collect logging
330330
information from the following places:
331331

332332
1. The most recent files from `~/.local/share/code-server/coder-logs`.
333-
2. The most recently created directory in the `~/.local/share/code-server/logs` directory.
334-
3. The browser console and network tabs.
333+
2. The browser console.
334+
3. The browser network tab.
335335

336336
Additionally, collecting core dumps (you may need to enable them first) if
337337
code-server crashes can be helpful.

0 commit comments

Comments
 (0)