Skip to content

Commit 0aba4d9

Browse files
committed
Fixes #399
Organized the commit message section and rules for better clarity and structured presentation. Added examples to illustrate proper formatting.
1 parent e1a34ca commit 0aba4d9

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

.DS_Store

6 KB
Binary file not shown.

CONTRIBUTING.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,16 @@ When submitting pull requests:
6464

6565
## Commit Messages
6666

67-
Write clear, concise, and descriptive commit messages following this format:
67+
Write clear, concise, and descriptive commit messages to ensure the project history is easy to understand. Follow these guidelines:
6868

69-
**Format:**
69+
### General Rules:
70+
- Use the present tense (e.g., "Fix bug" instead of "Fixed bug").
71+
- Keep the summary line (the first line) under 50 characters.
72+
- Separate the summary from the body with a blank line.
73+
- Provide additional context or reasoning in the body if necessary.
74+
- Reference related issues at the end of the message.
75+
76+
### Format:
7077
```
7178
<Brief summary of changes (Aim for 50 characters max)>
7279
@@ -75,7 +82,7 @@ Write clear, concise, and descriptive commit messages following this format:
7582
[Reference relevant issues, e.g., Fixes #123]
7683
```
7784

78-
**Examples:**
85+
### Examples:
7986
```
8087
Fix typo in introduction section
8188
@@ -84,7 +91,9 @@ of the documentation.
8491
8592
Fixes #42
8693
```
94+
8795
**For more guidance, check out** [How to Write a Git Commit](https://cbea.ms/git-commit/).
96+
8897
## Review Process
8998

9099
- **Technical fixes** generally receive faster review.

0 commit comments

Comments
 (0)