Skip to content

Submitting code

Léo Cavaillé edited this page Jan 29, 2015 · 6 revisions

Generic advice

  • It's easier to have smaller changesets

Bisectability

Commit messages

Never use git commit -m "Fixed stuff", it usually means that you will just write the very first thing that comes to mind without much thought.

Instead, the commit shortlog should focus on describing the change in a sane way (you can add a [flag] as in this other naming convention.

The commit message should describe the reason for the change and extra details that will allow someone later on to understand in 5 seconds the same thing you've been working on for a day.

Examples, see:

New check

Improving check

Clone this wiki locally