WORK IN PROGRESS

description
For this project, we are using the method TDD. In this case, we will have a lot of commit with test error (that normal because we begin by writing a false test).

The thing is if someone else who don't know the project or even if we have to read our commit, we have to be sure witch test error is 'normal' (usefull).

That's why we need to fix a template for commit message.

what we need
On the commit message we have to:

• Write if there is an error when running the tests:
  • How many error there are.
  • On witch file are the errors.
  • What is the error get.
• If we fix a previous error:
  • Witch error was fixed.
  • How do we fix this error.
• Have to be quick.
• Have to write a wiki.

Example template
We can use that:

If we fixe an error:

[if we have an error:"Test wrong ([how many error]) - [the name of the first test doing an error]:"]
  - '[what is the first error get]'.
  - '[on witch file are the errors]'.
  - [if we fix a previous error:["resolve previous test error:"]
    - [all the thing you done to resolve the previous error].
  - commun commit message.

If we fixe an refactoring:

RF - ...

Example using the template