Guide Commits

Overall

• Commits should be separated in groups
• Commits should use the prefixes: (Added, Updated, Removed, Fixed)
• Commits should have brief and direct descriptions

In this guide we will try to give a "template" of how commits should work, take in mind that unique and specific variations may be required for unique and specific scenarios. With that said the following examples will display how a normal scenario should be handle:

Commits separation

Imagine the following files were changed:

• Main.java
• DBContextMegaPD.java
• Connection.java

Even though 3files where changed they are very specific files, therefore they should be committed in different push's. (this way it's easier to rollback and find specific problems)

Commits Prefixes

• Added - this prefix should be used every time a new functionality is added
• Updated - this prefix should be used every time a existing functionality is improved or modified
• Removed - this prefix should be used every time a new functionality is removed
• Fixed- this prefix should be used every time a existing functionality is tweaked to remove a bug

Commits Descriptions

Lets take our example and imagine that the DBContextMegaPD suffered various alterations. The prefix used should include the major alterations, so a good example of a description would be something like this:

       Added: better description
       Fixed: disconnection
       now it properly disconnects and updates the server status

Even though this commit evolved one addition and one fix, the overall file was updated. The functionalities of the file were extended per say, therefore the prefix should be Updated with a brief description of the changes.