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 CONTRIBUTING.md along with code style tasks #273

Merged

Conversation

mdedetrich
Copy link
Collaborator

Adds a CONTRIBUTING.md along with code aliases so you can easily format, clean the code.

@mdedetrich mdedetrich requested a review from raboof July 31, 2023 07:41
@@ -54,3 +54,6 @@ inThisBuild(
)
)
)

addCommandAlias("applyCodeStyle", ";+clean ;scalafixAll ;scalafmtAll; scalafmtSbt")
Copy link
Collaborator Author

@mdedetrich mdedetrich Jul 31, 2023

Choose a reason for hiding this comment

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

The +clean is here since scalafix uses scala compiler and if there is dirty state then it can only check code that is covered by the incremental compiler.

Also scalafixAll is run before scalafmtAll/scalafmtSbt since its possible that if scalafix applies some code changes, they then need to be formatted after.

@mdedetrich mdedetrich force-pushed the add-contributing-md-and-code-style-tasks branch from a54f704 to 8c8750c Compare July 31, 2023 07:55
@@ -0,0 +1,18 @@
# Contributing to Sbt Reproducible Builds
Copy link
Owner

Choose a reason for hiding this comment

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

Suggested change
# Contributing to Sbt Reproducible Builds
# Contributing to sbt-reproducible-builds

@raboof raboof merged commit e913f21 into raboof:main Jul 31, 2023
2 checks passed
@mdedetrich mdedetrich deleted the add-contributing-md-and-code-style-tasks branch July 31, 2023 09:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants