Commit message guidelines

Format of the commit message

--<type>: <parentFolderName>- <fileName> :<subject>

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

Subject line

The subject line contains a succinct description of the change.

Allowed <type> (REQUIRED)

• added (addition)
• deleted (deletion)
• fixed (bug fix)
• docs (documentation)
• refactored (formatting, missing semicolons, …)
• chored (maintain)

Allowed <parentFolderName> text (REQUIRED)

The parent folder name should be the just parent folder of the file you are modifying. For example: If you have modified Hollow Rombus folder your parent folder name will be Patterns.

<fileName> text (REQUIRED)

You must provide the full file name with proper extension

<subject> text (REQUIRED)

• use imperative, past tense: “changed” not “change” nor “changes”
• don't capitalize the first letter
• no dot (.) at the end

Examples:

--added: Chapter07- QuickSort.java 

--refactored: Chapter07- QuickSort.java : recursion logic changed

--docs: Array- ReadMe.md : added a new problem 

--fixed: Chapter07- QuickSort.java : fixed issue #122

--deleted: Chapter07- QuickSort.java : no longer required