diff --git a/Documentation/dev-contributing.txt b/Documentation/dev-contributing.txt index 775fe21571..a5a4f90602 100644 --- a/Documentation/dev-contributing.txt +++ b/Documentation/dev-contributing.txt @@ -97,6 +97,7 @@ and writing: ==== +[[git_commit_settings]] === A sample good Gerrit commit message: ==== Add sample commit message to guidelines doc diff --git a/Documentation/dev-intellij.txt b/Documentation/dev-intellij.txt index ae2dd4ede1..8f5b4d7860 100644 --- a/Documentation/dev-intellij.txt +++ b/Documentation/dev-intellij.txt @@ -81,6 +81,26 @@ the current date to new files. To disable that, follow these steps: . Select *File Header*. . Remove the template code in the right editor. +=== Commit message +To simplify the creation of commit messages which are compliant with the +<> format, do the following: + +. Go to *File -> Settings -> Version Control*. +. Check *Commit message right margin (columns)*. +. Make sure that 72 is specified as value. +. Check *Wrap when typing reaches right margin*. + +In addition, you should follow the instructions of +<> (if you haven't +done so already): + +* Install the Git hook for the `Change-Id` line. +* Set up the HTTP access. + +Setting up the HTTP access will allow you to commit changes via IntelliJ without +specifying your credentials. The Git hook won't be noticeable during a commit +as it's executed after the commit dialog of IntelliJ was closed. + == Run configurations Run configurations can be accessed on the toolbar. To edit them or add new ones, choose *Edit Configurations* on the drop-down list of the run configurations