03 - Commit comment template

Commit what?

  • Always commit code that worked and build properly

  • As far as possible, try to make commits that make sense in itself (one feature = one commit)

  • Never commit files that are specific to your project (ex: .project, .log, and in general all files that begin with a "dot")

How to commit

Commit names

Commits names must start with a reference to the Mantis ticket it refers to:

  • [Feat <number>] (in case of a [TA] Enhancement)

  • [Issue <number>] (in case of a [TA] Issue).

It permits to build a direct link to the Mantis ticket.

Example:

Push request workflow

  • Before pushing your commits, never forget to pull!

  • If you pull other developer's code, you might have to rebase your work (here is a fine link that explains all about rebase).