Clarify some tedious gotchas. #487
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reminder to add the .github/workflows/*.yml files to the git repository. A brief note about .scalafmt.conf for those who don't want to use the giter8 template.
armanbilge
reviewed
Apr 5, 2023
| @@ -31,6 +31,12 @@ sbt new typelevel/typelevel.g8 | |||
| This will guide you through the basic setup to create a new project with **sbt-typelevel** and **sbt-typelevel-site**. | |||
| Check out the [typelevel.g8](https://github.com/typelevel/typelevel.g8) project for more details. | |||
|
|
|||
| Alternatively, if you don't want to use Giter8, you can add a file called: `.scalafmt.conf` to your project root directory with the contents: | |||
There was a problem hiding this comment.
I suggest we move this to the FAQ. Unfortunately adding a .scalafmt.conf by itself is not the only thing you need to do to completely avoid the giter 8, so I think this might be confusing :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reminder to add the .github/workflows/*.yml files to the git repository. A brief note about .scalafmt.conf for those who don't want to use the giter8 template.