Commit Message Conventions

While you may enter anything in the commit message, we strongly recommend sticking to some convention when creating your commit messages.

A common convention is:

First line: 80-character title, phrased imperatively

Then if your change is complex, elaborate on the change in prose.

Change greeting from "Hi" to "Hello"

"Hi" is a bit too informal for a greeting. We should change it to "Hello" instead,
so that our users don't feel like we are being too informal. Blah blah blah blah.
Blah blah.

You may also refer to CS2103/T (Software Engineering)'s conventions for naming: https://se-education.org/guides/conventions/git.html

TODO: add negative examples of commit messages

Last updated