Commit Standard - AmayaHena/AreaDocumentation GitHub Wiki

Commit Standard

On this page, you'll find references for the following topics in the given sections:

ADD commit

This commit is used to add something to the project that wasn't here before.

Structure:

[ADD] // the name of your commit

Example:

[ADD] cors dependencies

UP commit

This commit is used to update something to the project that was here before.

Structure:

[UP] // the name of your commit

Example:

[UP] action name NewRedditPost according to the documentation

FIX commit

This commit is used to fix something in the project.

Structure:

[FIX] // the name of your commit

Example:

[FIX] build error, bad ports on docker

HOTFIX commit

This commit is used to fix something that compromised the integrity of the project.

WARNING: This type of commit is only allowed on the master branch, otherwise, the commit will be deleted.

Structure:

[HOTFIX] // the name of your commit

Example:

[HOTFIX] adjusting cors dependencies between server & web client