sbt / sbt/sbt-github-actions

Add scalafmt code formatter

Open
#144 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
199
Forks
67
Avg merge
6h 24m
Merged PRs (30d)
3

Description

I would like to propose adding scalafmt to this codebase for the same set of obvious reasons why having a code formatter is a good idea. The typical problem with adding a code formatter is it causes merge conflicts for currently open PR's however scalafmt is in a stage where there are only a couple of major PR's which are planned to be merged soon i.e.

The idea would be to introduce scalafmt after these PR's are merged. In regards to the actual scalafmt configuration, I am personally not that fussed. From introducing scalafmt to other projects usually there are 2 approaches to this, either try to find configuration that matches current style as much as possible (which can be a bit of work) or to just use something basic and deal with a large diff

@eed3si9n @armanbilge Thoughts?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the four referenced pull requests (#65, #136, #66, and #98) and the current Scala project configuration before choosing an introduction point. Decide whether the scalafmt configuration should match the existing style or use a basic configuration; done means scalafmt is added after the pending changes and the codebase has a consistent formatter setup.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.