Skip to content

Latest commit

 

History

History
26 lines (17 loc) · 1.12 KB

developpers.md

File metadata and controls

26 lines (17 loc) · 1.12 KB

Contribute

I'd love to have your patch! Please send as pull request or by email.

Commit

To help colaborators to work on this, we assume the following convention:

  • Feat: A new feature
  • Fix: A bug fix
  • Change: A behaviour
  • Docs: Documentation only changes
  • Style: Changes that do not affect the meaning of the code (white-space, formatting, missing seMi-colons, etc)
  • Refactor: A code change that neither fixes a bug nor adds a feature
  • Clean: A portion of legacy code
  • Perf: A code change that improves performance
  • Test: Adding missing or correcting existing tests
  • Chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

Each commit message must have a maximum lenght of 72 characters. The title must follow the imperative at the present tense. The title must start with an uppercase letter, and there is no dot at the end of the sentence. An easy way to remember is: ''if applied, this commit will <commit_title>''. Optionnaly, it is a good practice to add some explanations of what the commit do.