emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/company 1dd9e9a 1/4: Add Bug Report issue template


From: ELPA Syncer
Subject: [elpa] externals/company 1dd9e9a 1/4: Add Bug Report issue template
Date: Tue, 20 Jul 2021 19:57:09 -0400 (EDT)

branch: externals/company
commit 1dd9e9ad13d3bfadf2cd6a327e9f0e509134f4a8
Author: YE <yet@ego.team>
Commit: YE <yet@ego.team>

    Add Bug Report issue template
---
 .github/ISSUE_TEMPLATE/bug-report.md | 44 ++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

diff --git a/.github/ISSUE_TEMPLATE/bug-report.md 
b/.github/ISSUE_TEMPLATE/bug-report.md
new file mode 100644
index 0000000..f5328af
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -0,0 +1,44 @@
+---
+name: Bug report
+about: Report errors or unexpected behavior
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Please make sure to search in [existing 
issues](https://github.com/company-mode/company-mode/issues?q=) before filing a 
new report!**
+
+[Feel free to remove pre-filled text **after** reading it.]
+
+#### Output of the command `M-x company-diag`
+Before posting, look carefully at the output of this command.
+You may find important clues in it for figuring out the cause of the issue.
+
+In particular, note the value on the line starting with `Used backend:`
+- Compare the value to the names of the [third-party 
backends](https://github.com/company-mode/company-mode/wiki/Third-Party-Packages).
+  -  It's highly probable that the issue should be reported to the 
corresponding third-party package.
+- If the value is `company-capf`, then one more clue is on the line starting 
with `Value of c-a-p-f:`
+  -  The issue could have been caused by a function listed there.
+  -  Use `M-x find-function RET <function-name> RET` to identify to which 
package a function belongs.
+
+#### Describe the issue
+Provide a clear and concise description of what the issue is.  
+Copy/paste the exact error message: lookup for it in the **\*Messages\*** 
buffer.
+
+#### Steps to reproduce
+List the steps to reproduce the behavior.
+
+#### Expected behavior
+Provide a clear and concise description of what you expected to happen.
+
+#### Screenshots
+If applicable, add screenshots (not huge ones, please) to help explain your 
problem.
+
+#### The error backtrace
+If applicable, provide the backtrace of the error.  
+To enable backtracing, run the command: `M-x toggle-debug-on-error` *before* 
reproducing the error.  
+Copy/paste the text of the debugger’s backtrace. To disable backtracing, run 
the same command.
+
+#### Additional context
+Add any other context about the problem here.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]