Skip to content

Commit

Permalink
update doc and issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
d99kris committed Nov 29, 2022
1 parent ec01c0c commit 94e5428
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 45 deletions.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/bugreport.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Bug report
about: Report a bug by creating a new issue.
labels: bug
assignees: d99kris
---

**Description**:

**How to reproduce it**:

**Environment**:
- Version:
- OS / distro:
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Feature request
url: https://github.com/d99kris/nmail/discussions/new?category=ideas
about: Suggest a new feature by creating a new discussion.
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Question
about: Ask a question by creating a new issue.
labels: question
assignees: d99kris
---

**Question**:

49 changes: 4 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -593,51 +593,14 @@ Press `<` or `Left` to exit search results and go back to current folder
message list.


Reporting Bugs
==============

The preferred way of reporting bugs is by opening
[a Github issue](https://github.com/d99kris/nmail/issues/new). Providing a
copy of `~/.nmail/log.txt` when reporting the issue is preferred.
Troubleshooting
===============

Different verbosity levels are supported. The default logging level is very
brief, primarily to minimize performance overhead. However, when encountering
issues and reporting bugs, it is generally preferred to provide logs produced
in verbose mode. To enable verbose logging:
If any issues are observed, try running nmail with verbose logging

nmail --verbose

For certain low-level bugs it may be required to collect extra verbose logs.
This produces very large log files with detailed information. The extra verbose
logs typically contain actual email contents. Review and edit such logs to
remove any private information before sharing. To enable extra verbose logging:

nmail --extra-verbose

Default logging verbosity can be configured with `verbose_logging` parameter in
`~/.nmail/main.conf`.

Finally, for issues where the logging above does not provide sufficient
information, it may be necessary to run nmail through a debugger and capture
detailed backtraces for all threads when an issue occurs. A simple utility
is provided to run `nmail` through a debugger in the source package. Example
usage:

./utils/debug-nmail.sh

The utility also supports passing arguments to nmail, enabling running nmail
with a custom config directory, for example:

./utils/debug-nmail.sh -d ~/.nmail-hm

Once nmail exits, either normally or caused by a crash, the script outputs
information on where to obtain the log file, for example:

gdb log file written to:
/tmp/nmail-gdb-5244.txt

Review the resulting log file and ensure there are no clear text passwords
in it, before sharing it with others.
and provide a copy of `~/.nmail/log.txt` when reporting a bug.


User Discussion Forums
Expand All @@ -646,10 +609,6 @@ User Discussion Forums
For discussing nmail usage (including getting help from other users) a mailing
list and a Telegram group are available.

Bug reports and feature requests should however be reported using
[Github issues](https://github.com/d99kris/nmail/issues/new) to ensure they
are properly tracked and get addressed.

Mailing List
------------
Feel free to subscribe at
Expand Down

0 comments on commit 94e5428

Please sign in to comment.