github.com/cockroachdb/cockroach@v20.2.0-alpha.1+incompatible/.github/ISSUE_TEMPLATE/bug_report.md (about)

     1  ---
     2  name: Bug or crash report
     3  about: Report unexpected behavior to help us improve
     4  
     5  ---
     6  
     7  **Describe the problem**
     8  
     9  Please describe the issue you observed, and any steps we can take to reproduce it:
    10  
    11  **To Reproduce**
    12  
    13  What did you do? Describe in your own words.
    14  
    15  If possible, provide steps to reproduce the behavior:
    16  
    17  1. Set up CockroachDB cluster ...
    18  2. Send SQL ... / CLI command ...
    19  3. Look at UI / log file / client app ...
    20  4. See error
    21  
    22  **Expected behavior**
    23  A clear and concise description of what you expected to happen.
    24  
    25  **Additional data / screenshots**
    26  If the problem is SQL-related, include a copy of the SQL query and the schema
    27  of the supporting tables.
    28  
    29  If a node in your cluster encountered a fatal error, supply the contents of the
    30  log directories (at minimum of the affected node(s), but preferably all nodes).
    31  
    32  Note that log files can contain confidential information. Please continue
    33  creating this issue, but contact support@cockroachlabs.com to submit the log
    34  files in private.
    35  
    36  If applicable, add screenshots to help explain your problem.
    37  
    38  **Environment:**
    39   - CockroachDB version [e.g. 2.0.x]
    40   - Server OS: [e.g. Linux/Distrib]
    41   - Client app [e.g. `cockroach sql`, JDBC, ...]
    42  
    43  **Additional context**
    44  What was the impact?
    45  
    46  Add any other context about the problem here.