From 25ef76e754b792a58ef57db2937cca8ecaf0be74 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Sat, 27 Jun 2026 22:15:18 -0700 Subject: [PATCH] Convert ISSUES.md into a GitHub issue form Replace the static ISSUES.md instructions with a structured GitHub issue form so bug reports collect the needed details consistently. While converting, fix the stale `chefspec/chefspec` repo link, replace the deprecated `knife -v` with `chef --version`, drop the privacy-risky "paste everything from env" field, and add a missing ChefSpec version field. Signed-off-by: Tim Smith --- .github/ISSUE_TEMPLATE/bug_report.yml | 94 +++++++++++++++++++++++++++ ISSUES.md | 41 ------------ 2 files changed, 94 insertions(+), 41 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 ISSUES.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..2f5c33db --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,94 @@ +name: Bug Report +description: Report a problem with ChefSpec +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report an issue with ChefSpec! Filling out + the fields below helps us reproduce and resolve your issue quickly. + + Before opening a new issue, please search the + [existing issues](https://github.com/chef/chefspec/issues) to see if it + has already been reported. + - type: textarea + id: summary + attributes: + label: What are you trying to accomplish? + description: Describe what you were doing and what went wrong. + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Steps to reproduce + description: >- + A minimal, self-contained example that reproduces the problem (see + [SSCCE](http://sscce.org/)). Include the spec and any relevant recipe or + cookbook code. + render: ruby + validations: + required: true + - type: input + id: command + attributes: + label: Command run + placeholder: bundle exec rspec spec/unit/recipes/default_spec.rb + validations: + required: false + - type: textarea + id: expected + attributes: + label: Expected behavior + description: What did you expect to happen? + validations: + required: true + - type: textarea + id: actual + attributes: + label: Actual behavior + description: What actually happened? + validations: + required: true + - type: textarea + id: backtrace + attributes: + label: Exception and backtrace + description: Paste the full error message and backtrace, if any. + render: text + validations: + required: false + - type: input + id: os + attributes: + label: Operating system and version + validations: + required: true + - type: input + id: chefspec-version + attributes: + label: ChefSpec version + description: The version of the `chefspec` gem you are using. + validations: + required: true + - type: input + id: chef-version + attributes: + label: Chef version + description: Output of `chef --version`. + validations: + required: true + - type: input + id: ruby-version + attributes: + label: Ruby version + description: Output of `ruby -v`. + validations: + required: true + - type: input + id: rubygems-version + attributes: + label: RubyGems version + description: Output of `gem -v`. + validations: + required: false diff --git a/ISSUES.md b/ISSUES.md deleted file mode 100644 index c82d7acc..00000000 --- a/ISSUES.md +++ /dev/null @@ -1,41 +0,0 @@ -ChefSpec Issues ---------------- -This file documents the steps necessary to report and issue with ChefSpec. Following these guidelines will help ensure your issue is resolved in a timely manner. - -Reporting ---------- -When you report an issue, please include the following information: - -- What you're trying to accomplish -- An [SSCCE](http://sscce.org/) -- The command you ran -- What you expected to happen -- What actually happened -- The exception backtrace(s), if any -- What operating system and version -- Everything output by running `env` -- What version of Ruby you are using (run `ruby -v`) -- What version of Rubygems you are using (run `gem -v`) -- What version of Chef you are using (run `knife -v`) - -Here's a snippet you can copy-paste into the issue and fill out: - -```text -(What is the issue? What are you trying to do? What happened?) - -- Command: `...` -- OS: -- Ruby: -- Rubygems: -- Chef: -- env: - ```text - # Paste your env here - ``` -- Backtrace: - ```text - # Paste backtrace here - ``` -``` - -[Create a ticket](https://github.com/chefspec/chefspec/issues/new) describing your problem and include the information above.