github.com/QuangHoangHao/kafka-go@v0.4.36/.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
     6  assignees: ""
     7  ---
     8  
     9  **Describe the bug**
    10  
    11  > A clear and concise description of what the bug is.
    12  
    13  **Kafka Version**
    14  
    15  > - What version(s) of Kafka are you testing against?
    16  > - What version of kafka-go are you using?
    17  
    18  **To Reproduce**
    19  
    20  > Resources to reproduce the behavior:
    21  
    22  ```yaml
    23  ---
    24  # docker-compose.yaml
    25  #
    26  # Adding a docker-compose file will help the maintainers setup the environment
    27  # to reproduce the issue.
    28  #
    29  # If one the docker-compose files available in the repository may be used,
    30  # mentioning it is also a useful alternative.
    31  ```
    32  
    33  ```go
    34  package main
    35  
    36  import (
    37      "github.com/QuangHoangHao/kafka-go"
    38  )
    39  
    40  func main() {
    41      // Adding a fully reproducible example will help maintainers provide
    42      // assistance to debug the issues.
    43      ...
    44  }
    45  ```
    46  
    47  **Expected Behavior**
    48  
    49  > A clear and concise description of what you expected to happen.
    50  
    51  **Observed Behavior**
    52  
    53  > A clear and concise description of the behavior you observed.
    54  
    55  ```
    56  Often times, pasting the logging output from a kafka.Reader or kafka.Writer will
    57  provide useful details to help maintainers investigate the issue and provide a
    58  fix. If possible, providing stack traces or CPU/memory profiles may also contain
    59  valuable information to understand the conditions that triggered the issue.
    60  ```
    61  
    62  **Additional Context**
    63  
    64  > Add any other context about the problem here.