summaryrefslogtreecommitdiffstats
path: root/.github/CONTRIBUTING.md
diff options
context:
space:
mode:
authorTeemu Suo-Anttila <tsuoanttila@users.noreply.github.com>2018-04-30 14:23:22 +0300
committerGitHub <noreply@github.com>2018-04-30 14:23:22 +0300
commit1c2f99d2ecf68f3a1a2a87438eda648a1b8455f1 (patch)
tree1c57b6db8c0a4d8a025a46179c32942c505592eb /.github/CONTRIBUTING.md
parent46560c51f13cd0900b0f0b02ad9cd0875360d6de (diff)
downloadvaadin-framework-1c2f99d2ecf68f3a1a2a87438eda648a1b8455f1.tar.gz
vaadin-framework-1c2f99d2ecf68f3a1a2a87438eda648a1b8455f1.zip
Add mention of formatter plugin to CONTRIBUTING.md (#10853)
Diffstat (limited to '.github/CONTRIBUTING.md')
-rw-r--r--.github/CONTRIBUTING.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index cbae52717d..4e5c692ad4 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -14,6 +14,8 @@ Unless the issue is specific to a single version of the Framework, you should al
In your repo, make a new branch from `master`. Make your code changes in that branch, and once you're done make a pull request to the `vaadin/framework` branch `master`.
+The `vaadin/framework` project uses `formatter-maven-plugin` to format the code. It will be executed as part of the Maven build. Make sure to run `mvn compile` before making the commit.
+
We recommend making sure that the "Allow edits from maintainers" checkbox on the pull request page is checked. This allows us to commit minor fixes, like correcting typos, without bothering you.
### Getting feedback and responding to it