Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
W
widget_django unchained
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
1
Merge Requests
1
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Jose Emmanuel B. Laurel
widget_django unchained
Commits
c8d6741e
Commit
c8d6741e
authored
Apr 02, 2022
by
Ray Rafael Abenido
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Meta: added file 'git_conventions.md' to provide git commit message conventions for everyone.
parent
dc5b6def
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
45 additions
and
0 deletions
+45
-0
git_conventions.md
git_conventions.md
+45
-0
No files found.
git_conventions.md
0 → 100644
View file @
c8d6741e
# 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.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment