github.com/openfga/openfga@v1.5.4-rc1/.github/ISSUE_TEMPLATE/report_a_bug.yml (about)

     1  name: 🐛 Report a bug
     2  description: Have you found a bug or issue? Create a bug report for OpenFGA
     3  labels: [ "bug" ]
     4  
     5  body:
     6    - type: markdown
     7      attributes:
     8        value: |
     9          Thanks for taking the time to fill out this bug report!
    10  
    11    - type: markdown
    12      attributes:
    13        value: |
    14          **Please do not report security vulnerabilities here**. Use https://github.com/openfga/openfga/security/advisories/new or send us an email at security@openfga.dev instead.
    15  
    16    - type: checkboxes
    17      id: checklist
    18      attributes:
    19        label: Checklist
    20        options:
    21          - label: I have looked into the [README](https://github.com/openfga/openfga/blob/main/README.md) and have not found a suitable solution or answer.
    22            required: true
    23          - label: I have looked into the [documentation](https://openfga.dev/docs) and have not found a suitable solution or answer.
    24            required: true
    25          - label: I have searched the [issues](https://github.com/openfga/openfga/issues) and have not found a suitable solution or answer.
    26            required: true
    27          - label: I have upgraded to the [latest version](https://github.com/openfga/openfga/releases/latest) of OpenFGA and the issue still persists.
    28            required: true
    29          - label: I have searched the [OpenFGA Community](https://openfga.dev/community) and have not found a suitable solution or answer.
    30            required: true
    31          - label: I agree to the terms within the [OpenFGA Code of Conduct](https://github.com/openfga/.github/blob/main/CODE_OF_CONDUCT.md).
    32            required: true
    33  
    34    - type: textarea
    35      id: description
    36      attributes:
    37        label: Description
    38        description: Provide a clear and concise description of the issue.
    39      validations:
    40        required: true
    41  
    42    - type: textarea
    43      id: expectation
    44      attributes:
    45        label: Expectation
    46        description: Tell us about the behavior you expected to see.
    47      validations:
    48        required: true
    49  
    50    - type: textarea
    51      id: reproduction
    52      attributes:
    53        label: Reproduction
    54        description: Detail the steps taken to reproduce this error and, ideally, share a repo of a minimal reproducible example. State whether this issue can be reproduced consistently or if it is intermittent.
    55        placeholder: |
    56          1. Given...
    57          2. When...
    58          3. Then...
    59      validations:
    60        required: true
    61  
    62    - type: textarea
    63      id: store-data
    64      attributes:
    65        label: Store data
    66        description: If applicable, provide information about your authorization model, tuples, and the Check or ListObjects calls you're making.
    67        value: |
    68          ```yaml
    69          model_file: |
    70            model
    71              schema 1.1
    72            type user
    73            type organization
    74              relations
    75                define member: [user]
    76          tuples:
    77            - user: user:anne
    78              relation: member
    79              object: organization:openfga
    80            - user: user:bob
    81              relation: member
    82              object: organization:openfga
    83          tests: # remove this if not a bug in Check or ListObjects API
    84            - name: test-1
    85              check:
    86                - user: user:anne
    87                  object: organization:openfga
    88                  assertions:
    89                    member: true
    90              list_objects:
    91                - user: user:anne
    92                  type: organization
    93                  assertions:
    94                    member:
    95                      - organization:openfga
    96          ```
    97      validations:
    98        required: false
    99  
   100    - type: input
   101      id: environment-openfga-version
   102      attributes:
   103        label: OpenFGA version
   104        description: The version of OpenFGA you're using.
   105      validations:
   106        required: true
   107  
   108    - type: dropdown
   109      id: environment-openfga-runnable
   110      attributes:
   111        label: How are you running OpenFGA?
   112        options:
   113          - As a binary
   114          - In Docker
   115          - In Kubernetes
   116      validations:
   117        required: true
   118  
   119    - type: dropdown
   120      id: environment-datastore-version
   121      attributes:
   122        label: What datastore are you using?
   123        options:
   124          - In-Memory
   125          - MySQL
   126          - Postgres
   127      validations:
   128        required: true
   129  
   130    - type: input
   131      id: environment-openfga-flags
   132      attributes:
   133        label: OpenFGA Flags
   134        description: Are you running OpenFGA with any configuration overrides or with any of the flags mentioned in `./openfga run --help`?
   135      validations:
   136        required: true
   137  
   138    - type: textarea
   139      id: logs
   140      attributes:
   141        label: Logs
   142        description: Do you have any logs or traces that could help us debug the problem?
   143      validations:
   144        required: false