opendev/gerrit
Code Issues Proposed changes

Describe commit message settings for IntelliJ

Browse Source 
Change-Id: Ieaf7432aca8a8abe1adf560381c4f2c65a35cfff
This commit is contained in:
Alice Kober-Sotzek
2016-11-25 15:22:38 +01:00
parent b11a075730
commit 6af5c3bc21
2 changed files with 21 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
Documentation/dev-contributing.txt
View File

@@ -97,6 +97,7 @@ and writing:
====
[[git_commit_settings]]
=== A sample good Gerrit commit message:
====
Add sample commit message to guidelines doc

20
Documentation/dev-intellij.txt
View File

@@ -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
<<dev-contributing#commit-message,Commit Message>> 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
<<dev-contributing#git_commit_settings,this section>> (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