From 3e4067e9b5ae04f67e55b257a8d1871108b601ce Mon Sep 17 00:00:00 2001
From: Albert Meltzer <7529386+kitbellew@users.noreply.github.com>
Date: Sun, 14 Apr 2024 06:53:07 -0700
Subject: [PATCH] Add a template describing issue requirements

---
 .github/ISSUE_TEMPLATE.md | 55 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE.md

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 0000000..ccb89ff
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,55 @@
+This template is mostly a guideline, not a strict requirement, except
+the sections marked `(required)`.
+
+Please make sure that the issue is specific to the plugin for sbt that is
+observable only using the latest version of `sbt-scalafmt` and does not
+appear if you use the `scalafmt` **CLI** using the same `.scalafmt.conf`:
+`https://scalameta.org/scalafmt/docs/installation.html#cli`
+
+Prior check via the CLI is _mandatory_.
+
+## Configuration (required) ##
+
+Please paste the values of all `sbt-scalafmt`
+[settings](https://scalameta.org/scalafmt/docs/installation.html#settings)
+found in your `build.sbt` file here:
+```
+scalafmtConfig = <please enter the file location here>
+...
+```
+
+Please paste the contents of your `.scalafmt.conf` file (mentioned above
+under `scalafmtConfig` sbt setting) here:
+```
+version = <please enter the version here and make sure it's the latest>
+...
+```
+
+NB: before submitting, please confirm that the problem is observed in
+the *latest published* version of the sbt plugin! We don't publish
+hotfixes for older versions, and the problem you have observed in an
+older version may have already been fixed.
+
+## Command-line parameters (required) ##
+
+When I run sbt-scalafmt via `sbt` like this: `<sbt command-line parameter>`
+
+## Problem (required)
+
+`sbt-scalafmt` fails to format files mentioned below, or issues an
+error as follows:
+```scala
+OUTPUT FROM SBT-SCALAFMT
+```
+
+## Expectation
+
+...
+
+## Workaround
+
+I've found that by...
+
+## Notes
+
+See also...