/ .github / ISSUE_TEMPLATE / bug_report.yml
bug_report.yml
  1  name: Bug report
  2  description: Create a bug report. Please use the discussions section for general or troubleshooting questions.
  3  title: '[bug]: '
  4  labels: ["bug", "needs triage"]
  5  
  6  body:
  7   - type: markdown
  8     attributes:
  9       value: |
 10         Thanks for taking the time to fill out this bug report! Please provide
 11          as much detail as possible.
 12  
 13   - type: checkboxes
 14     id: pre-check
 15     attributes:
 16       label: Pre-Submission Checklist
 17       description: "Please verify the following before submitting the bug report."
 18       options:
 19         - label: "I have searched the existing issues and believe this is a new bug."
 20           required: true
 21         - label: "I am not asking a question about how to use lnd, but reporting
 22            a bug (otherwise open a discussion)."
 23           required: true
 24  
 25   - type: input
 26     id: environment-lnd-version
 27     attributes:
 28       label: LND Version
 29       description: "The version of lnd, which can be found using `lncli version`
 30        or `lnd --version`."
 31       placeholder: "e.g., v0.19.3-beta-1-gfbe71ced3"
 32     validations:
 33       required: true
 34  
 35   - type: textarea
 36     id: environment-lnd-config
 37     attributes:
 38       label: LND Configuration
 39       description: "Please provide details about your lnd setup. Include/upload
 40        `lnd.conf` contents (**with sensitive data removed**)."
 41       placeholder: |
 42         lnd.conf:
 43         ...
 44     validations:
 45       required: true
 46  
 47   - type: input
 48     id: environment-backend-version
 49     attributes:
 50       label: Backend Version
 51       description: "The version of bitcoind/btcd, which can be found using
 52        `bitcoind/btcd --version`."
 53       placeholder: "e.g., Bitcoin Core v29.0.0"
 54     validations:
 55       required: true
 56  
 57   - type: textarea
 58     id: environment-backend-config
 59     attributes:
 60       label: Backend Configuration
 61       description: "Please provide details about your backend. Include/upload
 62        `bitcoin.conf`/`btcd.conf` contents (**with sensitive data removed**)."
 63       placeholder: |
 64         bitcoin/btcd.conf:
 65         ...
 66     validations:
 67       required: true
 68  
 69   - type: input
 70     id: environment-os
 71     attributes:
 72       label: OS/Distribution
 73       description: "Your operating system/distribution (e.g., from `uname -a`)
 74        and any node packaging used."
 75       placeholder: "e.g., Ubuntu 22.04 or SomeNodeProject"
 76     validations:
 77       required: true
 78  
 79   - type: textarea
 80     id: bug-description
 81     attributes:
 82       label: Bug Details & Steps to Reproduce
 83       description: "Describe the action you attempted and what didn't work as
 84        expected. Provide clear steps to reproduce the issue."
 85       placeholder: |
 86         1. I tried to...
 87         2. Then I...
 88         3. The error occurred.
 89     validations:
 90       required: true
 91  
 92   - type: textarea
 93     id: expected-behaviour
 94     attributes:
 95       label: Expected Behavior
 96       description: "Explain what you expected to happen."
 97     validations:
 98       required: true
 99  
100   - type: textarea
101     id: debuginfo
102     attributes:
103       label: Debug Information
104       description: "Please include/upload relevant logs or stack traces with
105        [appropriate subsystem log levels](https://github.com/lightningnetwork/lnd/blob/master/docs/debugging_lnd.md#debug-logging).
106        Also relevant are [goroutine](https://github.com/lightningnetwork/lnd/blob/master/docs/debugging_lnd.md#goroutine-profile)
107        for hanging commands or [memory](https://github.com/lightningnetwork/lnd/blob/master/docs/debugging_lnd.md#heap-profile)
108        profiles."
109  
110   - type: textarea
111     id: environment-misc
112     attributes:
113       label: Environment
114       description: "If available, give additional information about the
115        environment LND runs in. Describe your network setup, including any
116        proxies or container configurations. Also, list any other applications
117        that interact with LND."
118       placeholder: "e.g., behind VPN, in a Docker container, using a rebalance
119        script and lightning-terminal"