github.com/aretext/aretext@v1.3.0/.github/ISSUE_TEMPLATE/bug_report.md (about)

     1  ---
     2  name: Bug report
     3  about: Create a report to help us improve
     4  title: ''
     5  labels: bug, needs-triage
     6  assignees: ''
     7  
     8  ---
     9  
    10  **Describe the bug**
    11  A clear and concise description of what the bug is.
    12  
    13  **To Reproduce**
    14  Steps to reproduce the behavior:
    15  1. Open document '....'
    16  2. Type command '....'
    17  3. See error
    18  
    19  **Expected behavior**
    20  A clear and concise description of what you expected to happen.
    21  
    22  **Screenshots**
    23  If applicable, please add screenshots to help explain your problem.
    24  
    25  **Logs**
    26  If applicable, please reproduce the issue while running `aretext -log debug.log` and attach `debug.log` to this issue.
    27  
    28  **System (please complete the following information):**
    29   - OS: [e.g. Linux]
    30   - Terminal: [e.g. xterm, alacritty]
    31   - Version: [output of `aretext -version`]
    32  
    33  **Additional context**
    34  Add any other context about the problem here.
    35  
    36  **Has aretext made you happy in any way?**
    37  Answering this question is not required, but if you have anything positive to share, please do so here!
    38  Sometimes we get tired of reading bug reports all day and a little positive end note does wonders.
    39  Idea by Joey Hess, https://joeyh.name/blog/entry/two_holiday_stories/