[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/company 1372d4b 2/2: Some copy edits on the template
From: |
ELPA Syncer |
Subject: |
[elpa] externals/company 1372d4b 2/2: Some copy edits on the template |
Date: |
Tue, 20 Jul 2021 20:57:06 -0400 (EDT) |
branch: externals/company
commit 1372d4b0102ece1a3700f5157b918955ec6b0d3e
Author: Dmitry Gutov <dgutov@yandex.ru>
Commit: Dmitry Gutov <dgutov@yandex.ru>
Some copy edits on the template
---
.github/ISSUE_TEMPLATE/bug-report.md | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md
b/.github/ISSUE_TEMPLATE/bug-report.md
index f5328af..e258b3c 100644
--- a/.github/ISSUE_TEMPLATE/bug-report.md
+++ b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -17,28 +17,28 @@ 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.
+ - It's likely that the issue should be reported to the corresponding
third-party package instead.
- 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.
+ - Use `M-x find-function RET <function-name> RET` to identify which package
it belongs to.
#### 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.
+Short description of the problem.
+Copy/paste the exact error message: you can find it in the **\*Messages\***
buffer.
#### Steps to reproduce
-List the steps to reproduce the behavior.
+List the steps to reproduce the behavior. Ideally starting with a bare Emacs
session: `emacs -Q` (if you can).
#### 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.
+Description of what you expected to happen.
#### 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.
+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.
+#### Screenshots
+If applicable, add screenshots (not huge ones, please) to help explain your
problem.
+
#### Additional context
-Add any other context about the problem here.
+Add any other relevant information here.