Commit message guidelines

Main repository (source code repository)

1. First line must have the following structure:

   <type> - <commit description>
   

   • <type>:

     Must be any of the following:

     • DOCS:

       Used to clarify that some documentation of the project was added or updated.

       This may include (but not limited to) updates to README.md file.

     • ENHANCEMENT:

       Used to clarify that some improvements were applied to existent functionality.

       E.g: ENHANCEMENT - Add user verification through email

     • FEATURE:

       Used to clarify that new specific functionality was added.

       E.g: FEATURE - Add view to register

     • FIX:

       Used to clarify that an introduced bug in any of functionality or enhancement was fixed.

       E.g: FIX - Format logs with Apache Logger instead of String.format

     • fix:

       Used only by @snyk-bot when makes a pull request to the repository.

       This may includes (but not limited to) updates of vulnerable dependencies.

     • MERGE:

       Used to clarify that a merge of external or internal branches was applied.

       E.g: MERGE - Pull request #6

     • SECURITY:

       Used to clarify that the committed changes are security-related.

       This may include patches to security issues or updates of vulnerable dependencies.

   • <commit description>:

     A capitalized, short (50 characters or less) summary of the committed changes.

Wiki repository

1. First line must have the following structure:

   <type> - <commit description>
   

   • <type>:

     Must be any of the following:

     • CREATE:

       Used to clarify that a new page was added to the wiki.

   • <commit description>:

     A capitalized, short (50 characters or less) summary of the committed changes.