Changes between Version 27 and Version 28 of HowToContribute

Timestamp:

2017-11-21T23:11:57Z (7 years ago)

Author:

Jakub Jermář

Comment:

Improve suggestions on writing commit messages

HowToContribute

@@ -22 +22 @@
 == Working on your branch ==
 
-Now that you know what to do, you should go and create your private [https://www.atlassian.com/git/tutorials Git clone] of HelenOS. The easiest way is to [https://github.com/HelenOS/helenos#fork-destination-box fork HelenOS on GitHub]. This is essential so that we can later merge your changes together with your initials in the development history of the branch. During the coding phase, keep in mind that we will require your changes to meet our [wiki:CStyle coding style standards]. It will happen to you from time to time that you will need to consult something with the other people from the project. Don't be shy and feel free to discuss things with us either in the mailing list or on IRC. For example, you can create a patch and send it to the mailing list for code review. Alternatively, you can open a [https://github.com/HelenOS/helenos/compare PR on GitHub]. Make smaller, logically related changesets rather than one huge changeset. Make sure that each changeset is accompanied by a clear commit message in English.
+Now that you know what to do, you should go and create your private [https://www.atlassian.com/git/tutorials Git clone] of HelenOS. The easiest way is to [https://github.com/HelenOS/helenos#fork-destination-box fork HelenOS on GitHub]. This is essential so that we can later merge your changes together with your initials in the development history of the branch. During the coding phase, keep in mind that we will require your changes to meet our [wiki:CStyle coding style standards]. It will happen to you from time to time that you will need to consult something with the other people from the project. Don't be shy and feel free to discuss things with us either in the mailing list or on IRC. For example, you can create a patch and send it to the mailing list for code review. Alternatively, you can open a [https://github.com/HelenOS/helenos/compare PR on GitHub].
+
+Make smaller, logically related commits rather than one huge commit. Make sure that each commit is accompanied by a commit message that follows the example below. The first line should be a short description of **WHAT** the commit does written in imperative mood. It should not exceed 50 columns of text width and the trailing period should be omitted. The next line should be empty. Optionally, you may provide additional paragraphs that explain **WHY** the change was made. The text should not exceed 72 columns of width. Note that some editors will help you follow these rules by text highlighting. The entire commit message must be written in English.
+
+An example commit message may look like this:
+
+{{{
+Make INTERFACE_LOC_SUPPLIER parallel
+    
+Location service sometimes needs to be able to process requests in
+parallel in order to avoid deadlock.
+}}}
+
 
 == Submitting patches ==