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