diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5b0b29a2dc..0c44bbc548 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -64,7 +64,7 @@ The steps are exactly the same for everyone involved in the project, including t 1. Create a branch on your fork and work on the feature. For example: `git checkout -b custom-headers-pekko-http` - Please make sure to follow the general quality guidelines (specified below) when developing your patch. - Please write additional tests covering your feature and adjust existing ones if needed before submitting your pull request. The `validatePullRequest` sbt task ([explained below](#the-validatepullrequest-task)) may come in handy to verify your changes are correct. - - Use the `verifyCodeStyle` sbt task to ensure your code is properly formatted and includes the proper copyright headers. + - Use the `checkCodeStyle` sbt task to ensure your code is properly formatted and includes the proper copyright headers. 1. Once your feature is complete, prepare the commit following our guide [Creating Commits And Writing Commit Messages](#creating-commits-and-writing-commit-messages). For example, a good commit message would be: `Adding compression support for Manifests #22222` (note the reference to the ticket it aimed to resolve). 1. If it's a new feature or a change of behavior, document it on the [docs](https://github.com/apache/incubator-pekko/tree/main/docs). When the feature touches Scala and Java DSL, document both the Scala and Java APIs. 1. Now it's finally time to [submit the pull request](https://help.github.com/articles/using-pull-requests)! @@ -186,7 +186,7 @@ To verify code style with: ```shell sbt -verifyCodeStyle +checkCodeStyle ``` To apply code style with: diff --git a/build.sbt b/build.sbt index d3b72b3998..7911204146 100644 --- a/build.sbt +++ b/build.sbt @@ -37,7 +37,7 @@ enablePlugins( JavaFormatterPlugin) disablePlugins(MimaPlugin) -addCommandAlias("verifyCodeStyle", "scalafmtCheckAll; scalafmtSbtCheck; javafmtCheckAll; +headerCheckAll") +addCommandAlias("checkCodeStyle", "scalafmtCheckAll; scalafmtSbtCheck; javafmtCheckAll; +headerCheckAll") addCommandAlias("applyCodeStyle", "+headerCreateAll; scalafmtAll; scalafmtSbt; javafmtAll") addCommandAlias(