Commit 9627f289 authored by Ray Rafael Abenido's avatar Ray Rafael Abenido

Meta: reformatted 'git_conventions.md' to be cleaner.

parent d1c3cff8
...@@ -18,7 +18,7 @@ will be cases where the new conventions you added will be needed. ...@@ -18,7 +18,7 @@ will be cases where the new conventions you added will be needed.
Thanks! ~ Ray Thanks! ~ Ray
## GIT CONVENTIONS (AS OF 04/02/2022) ## GIT CONVENTIONS (AS OF 04/02/2022)
# GENERAL RULES ### GENERAL RULES
Git messages should be as follows: Git messages should be as follows:
> SUBJECT: A summary of what you did > SUBJECT: A summary of what you did
...@@ -28,19 +28,23 @@ As much as possible, your git messages should follow these guidelines. ...@@ -28,19 +28,23 @@ As much as possible, your git messages should follow these guidelines.
1. Your git messages should be two or three sentences at most. Two is best. 1. Your git messages should be two or three sentences at most. Two is best.
2. Each sentence should communicate intent, explicitly, and <b>not vague</b>. 2. Each sentence should communicate intent, explicitly, and <b>not vague</b>.
# Types of Subject ### Types of Subject
1. Fix: if you fixed a bug in the project. 1. Fix: if you fixed a bug in the project.
2. Style: if you're changes you make has an impact on the GUI. 2. Style: if you're changes you make has an impact on the GUI.
3. Improvement: if you made an improvements on pre-existing feature 3. Improvement: if you made an improvements on pre-existing feature
4. Clean: if you cleaned messy code by reformatting, restructuring, changing 4. Clean: if you cleaned messy code by reformatting, restructuring, changing
variable, function, or class names, etc. variable, function, or class names, etc.
5. Meta: if you have modified the README.md file or added new files that are 5. Feature: if you added a new feature or expanded a pre-existing one.
6. Test: if you have not made any changes to the code but tested the project.
7. 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 not part of the project itself but provides information to programmers on how
to write the program to write the program.
6. Others: if it doesn't fit in with the any of the above. AS MUCH AS POSSIBLE 8. Others: if it doesn't fit in with the any of the above. <b>Avoid this subject
AVOID THIS. header as much as possible.</b>
# Other Guidelines ### Other Guidelines
1. One commit message can have multiple subjects. For example, "New Feature: 1. One commit message can have multiple subjects. For example,
added foo. Clean: reformatted views.py of homepage." However, the next subject > New Feature: added foo. Clean: reformatted views.py of homepage.
must be in a newline. However, the next subject must be in a newline. For example,
> New Feature: added foo
> Clean: reformatted views.py of homepage
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