From 82a71ef33ba9b6ea04bec9ad5b1528340327c0f7 Mon Sep 17 00:00:00 2001 From: shreyas-goenka <88374338+shreyas-goenka@users.noreply.github.com> Date: Mon, 30 Oct 2023 12:26:01 +0100 Subject: [PATCH] Add GitHub issue templates (#925) This PR adds a few github issue templates, allowing customers to give feedback and report issues in a more structured way. --- .github/ISSUE_TEMPLATE/cli-issue.md | 29 ++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/dabs-issue.md | 33 ++++++++++++++++++++++++++++ 3 files changed, 63 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/cli-issue.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/dabs-issue.md diff --git a/.github/ISSUE_TEMPLATE/cli-issue.md b/.github/ISSUE_TEMPLATE/cli-issue.md new file mode 100644 index 0000000000..6a8a75f74a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/cli-issue.md @@ -0,0 +1,29 @@ +--- +name: Bug report for the CLI +about: Use this to report an issue with the CLI. +title: '' +labels: CLI +--- + +### Describe the issue +A clear and concise description of what the issue is + +### Steps to reproduce the behavior +Please list the steps required to reproduce the issue, for example: +1. Run `databricks clusters ...` +2. See error + +### Expected Behavior +Clear and concise description of what should have happened + +### Actual Behavior +Clear and concise description of what actually happened + +### OS and CLI version +Please include the version of the CLI (eg: v0.1.2) and the operating system (eg: windows). You can run databricks --version to get the version of your Databricks CLI + +### Is this a regression? +Did this work in a previous version of the CLI? If so, which versions did you try? + +### Debug Logs +Output logs if you run the command with debug logs enabled. Example: databricks clusters list --log-level=debug. Redact if needed diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..0086358db1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/dabs-issue.md b/.github/ISSUE_TEMPLATE/dabs-issue.md new file mode 100644 index 0000000000..dff820265f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/dabs-issue.md @@ -0,0 +1,33 @@ +--- +name: Bug report for Databricks Asset Bundles +about: Use this to report an issue with Databricks Asset Bundles. +labels: DABs +title: '' +--- + +### Describe the issue +A clear and concise description of what the issue is + +### Configuration +Please provide a minimal reproducible configuration for the issue + +### Steps to reproduce the behavior + Please list the steps required to reproduce the issue, for example: +1. Run `databricks bundle deploy ...` +2. Run `databricks bundle run ...` +3. See error + +### Expected Behavior +Clear and concise description of what should have happened + +### Actual Behavior +Clear and concise description of what actually happened + +### OS and CLI version +Please provide the version of the CLI (eg: v0.1.2) and the operating system (eg: windows). You can run databricks --version to get the version of your Databricks CLI + +### Is this a regression? +Did this work in a previous version of the CLI? If so, which versions did you try? + +### Debug Logs +Output logs if you run the command with debug logs enabled. Example: databricks bundle deploy --log-level=debug. Redact if needed