Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a template describing issue requirements #315

Merged
merged 1 commit into from
Apr 14, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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...