Commit c8d6741e authored by Ray Rafael Abenido's avatar Ray Rafael Abenido

Meta: added file 'git_conventions.md' to provide git commit message conventions for everyone.

parent dc5b6def
# GIT CONVENTIONS
## FOREWORD
(Do not edit this foreword)
I have been viewing our past commit messages recently and while it does explain
the changes we made, it can be greatly improved through standardizing our GIT
messages. I'm creating this MarkDownfile (.md) to list down all the conventions
I found on the internet and modified for this project. I'm hoping that all of
us will follow these conventions. This is not just for me, this is for all of
us.
If you feel you can add more to this file, go ahead. The conventions I listed
here are by no means comprehensive or complete, but what I think is sufficient
enough for us as of writing this file (04/02/2022). Just make sure that there
will be cases where the new conventions you added will be needed.
Thanks! ~ Ray
## GIT CONVENTIONS (AS OF 04/02/2022)
Git messages should be as follows:
> SUBJECT: A summary of what you did
An example. <i> New Feature: added a new database named 'ID' in homepage. </i>
As much as possible, your git messages should follow these guidelines.
- Your git messages should be two or three sentences at most. Two is best.
- Each sentence should communicate intent, explicitly, and <b>not vague</b>.
<b> Types of Subject </b>
- Fix: if you fixed a bug in the project.
- Style: if you're changes you make has an impact on the GUI.
- Improvement: if you made an improvements on pre-existing feature
- Clean: if you cleaned messy code by reformatting, restructuring, changing
variable, function, or class names, etc.
- Meta: if you have modified the README.md file or added new files that are
not part of the project itself but provides information to programmers on how
to write the program
- Others: if it doesn't fit in with the any of the above. AS MUCH AS POSSIBLE
AVOID THIS.
<b> Other Guidelines </b>
- One commit message can have multiple subjects. For example, "New Feature:
added foo. Clean: reformatted views.py of homepage." However, the next subject
must be in a newline.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment