sigs.k8s.io/kubebuilder/v3@v3.14.0/.github/ISSUE_TEMPLATE/bug_report.yaml (about)

     1  name: Bug Report
     2  description: Problems and issues with code or docs
     3  labels:
     4  - kind/bug
     5  body: 
     6  - type: markdown
     7    attributes:
     8      value: |
     9        :warning: **Stop!** :warning:
    10  
    11        * If this is an issue with some sort of **runtime mechanics**,
    12          it probably belongs in [controller-runtime][cr-issue] instead
    13  
    14        * If this is an issue with **CRD generation**, webhook config generation,
    15          or deepcopy generation, it probably belongs in [controller-tools][ct-issue].
    16  
    17        * If this is an issue with **scaffolding**, or is definitely a
    18          cross-repository effort, it probably belongs here.  Feel free to continue :wink:
    19  
    20        [cr-issue]: https://github.com/kubernetes-sigs/controller-runtime/issues/new
    21        [ct-issue]: https://github.com/kubernetes-sigs/controller-tools/issues/new
    22  
    23  - type: markdown
    24    attributes:
    25      value: |
    26        # Hiya!  Welcome to Kubebuilder!
    27        
    28        For a smooth issue process, try to answer the following questions.
    29        Don't worry if they're not all applicable; just try to include what you can :smile:
    30  
    31        If you need to include code snippets or logs, please put them in fenced code
    32        blocks, and if they're really long, use the [`<details>` tag][mdn-details], like:
    33  
    34        <details>
    35  
    36        <summary>Code & details examples</summary>
    37        
    38        `````markdown
    39        Some code written in Go:
    40  
    41        ```go
    42        type Manager struct {
    43          // FixTheBug removes all bugs from controller-runtime
    44          FixTheBug bool
    45        }
    46        ```
    47  
    48        <details>
    49  
    50        <summary>Some really long logs</summary>
    51  
    52        ```
    53        ok
    54        ok
    55        ok
    56        SHOOT A BUG HAPPENS HERE OH NO
    57        ok
    58        ok
    59        done
    60        ```
    61  
    62        </details>
    63  
    64        `````
    65  
    66        [mdn-details]: ://developer.mozilla.org/en-US/docs/Web/HTML/Element/details 
    67  
    68  - type: textarea
    69    attributes:
    70      label: What broke? What's expected?
    71      description: |
    72        Describe what didn't go the way you thought it would.
    73        Please include *full* & *exact* error messages if you can!
    74  
    75        If you have an idea of what went wrong, feel free to include that
    76        as well.
    77    validations: {required: true}
    78   
    79  - type: textarea
    80    attributes:
    81      label: Reproducing this issue
    82      description:
    83        If you have simple reproduction steps, or a minimal reproducer code
    84        snippet, please include it here.
    85  
    86        If they're already described above, no need to duplicate it here :smile:.
    87  
    88  - type: markdown
    89    attributes:
    90      value: |
    91        ## What versions are you using?
    92        
    93        Please specify the relevant versions and sources for the pieces of
    94        kubebuilder that you're using.  The more details you can provide, the
    95        better.
    96  
    97  - type: input
    98    id: cli-version
    99    attributes:
   100      label: KubeBuilder (CLI) Version
   101      description: "use `kubebuilder version` to find this out"
   102    validations:
   103      required: true
   104  
   105  # project-version & plugin versions are not required for issues with initial scaffolding
   106  - type: input
   107    id: project-version
   108    attributes:
   109      label: PROJECT version
   110      description: "look for the `version` field in your PROJECT file to find this"
   111  
   112  - type: textarea
   113    attributes:
   114      label: Plugin versions
   115      description: "list the values of the `layout` field in your PROJECT file, if on KubeBuilder v3+"
   116      render: yaml
   117  
   118  - type: textarea
   119    attributes:
   120      label: Other versions
   121      description: |
   122        Often times, the following pieces of information are relevant:
   123        - Go version (`go version`)
   124        - controller-runtime & controller-tools version (check your `go.mod` file)
   125        - Kubernetes & kubectl versions (run `kubectl version` against your api server)
   126  
   127  - type: dropdown
   128    attributes: 
   129      label: "Extra Labels"
   130      description: |
   131        If this is *also* a documentation request, etc, please select that below.
   132      multiple: true
   133      options:
   134      - "/kind documentation"
   135      - "/kind feature"
   136      - "/kind regression"
   137      - "/kind deprecation"
   138      - "/kind cleanup"