From d3f1daa413ddae4c85fd01799171aac70101ff08 Mon Sep 17 00:00:00 2001 From: Albert Meltzer <7529386+kitbellew@users.noreply.github.com> Date: Thu, 3 Mar 2022 07:29:07 -0800 Subject: [PATCH] Issue template: force using latest version, CLI (#3143) --- .github/ISSUE_TEMPLATE.md | 38 +++++++++++++++++++++++++------------- 1 file changed, 25 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 3200e227a3..1f1b082ce8 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,12 +1,30 @@ -This template is a guideline, not a strict requirement. -- **Version**: 0.5 -- **Integration**: IntelliJ -- **Configuration**: +This template is mostly a guideline, not a strict requirement. + +Please make sure that the issue is observable using the latest version of `scalafmt` and within the `scalafmt` CLI: `https://scalameta.org/scalafmt/docs/installation.html#cli` + +## Configuration (required) ## ``` -version = 2.0.1 -maxColumn = 100 +version = +... ``` +NB: before submitting, please confirm that the problem is observed in the +*latest published* version of the formatter! 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 scalafmt via CLI like this: `` + +If you were not using CLI initially: +- please check using `scalafmt` CLI before submitting here +- if the problem does not present via CLI, instead please submit the issue in + the appropriate tool's repository + - for instance, if the tool is `sbt` with the `sbt-scalafmt` plugin: please + submit in `sbt-scalafmt` and include scalafmt parameters from `build.sbt` + and the `sbt` command used + ## Steps Given code like this: @@ -14,12 +32,6 @@ Given code like this: ORIGINAL CODE ``` -When I run scalafmt like this: - -```bash -scalafmt -``` - ## Problem Scalafmt formats code like this: @@ -40,4 +52,4 @@ I've found that by... ## Notes -See also.. +See also...