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

Clarify some tedious gotchas. #487

Open
wants to merge 2 commits into
base: series/0.4
Choose a base branch
from

Conversation

dragonfly-ai
Copy link

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.

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.
@mergify mergify bot added the docs label 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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants