summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorIlia Motornyi <elmot@vaadin.com>2018-07-10 12:59:02 +0300
committerTeemu Suo-Anttila <tsuoanttila@users.noreply.github.com>2018-07-10 12:59:02 +0300
commit7f06076dc4bd4cbdc5a2cc6cde00adb6dec1de2e (patch)
tree53b749ea56dcaa0dca28b0f5e466f14debe604a3 /CONTRIBUTING.md
parent71b6a20b60d8e3021ab1459bdf2ff1b9c5e3e6ab (diff)
downloadvaadin-framework-7f06076dc4bd4cbdc5a2cc6cde00adb6dec1de2e.tar.gz
vaadin-framework-7f06076dc4bd4cbdc5a2cc6cde00adb6dec1de2e.zip
Fix formatting, improve documentation on autoformat (#11033)
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 43284b672c..3457ce0863 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -144,6 +144,10 @@ You should receive comments within a week or so; if that does not happen, make s
# Submitting the patches
+## Source code auto-formatting
+
+Before submitting changes to Github, run the command `mvn process-sources` from project's root. This maven goal automatically formats source code according to Vaadin standards. The same goal is run automatically if you invoke `mvn install` or `mvn compile`.
+
## Creating a pull request in GitHub
All our projects accept contributions as GitHub pull requests. The first time you create a pull request, you will be asked to electronically sign a contribution agreement.