Skip to content

Commit

Permalink
docs(contributing): update commit message convention (#110)
Browse files Browse the repository at this point in the history
* docs(contributing): update commit message convention

* docs(contributing): apply PR review feedback
  • Loading branch information
jiji-hoon96 authored Jan 23, 2025
1 parent 8e8c260 commit dc9376b
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,11 +88,11 @@ Before proposing changes, please **open an issue** to discuss the bug or feature
```
We recommend following the Conventional Commits standard for clear and consistent commit messages. Below is the suggested structure:

| Element | Requirement | Description |
|--------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `<type>` | **Required** | Describes the purpose of the commit. Examples: `feat`, `fix`, `docs`, `style`, `refactor`, `test`. |
| `<scope>` | **Optional** | Specifies the affected module, file, or functionality. Limited to **20 characters** (e.g., `auth`, `header`). |
| `<subject>` | **Required** | A concise summary of the changes:<br/> - Starts with a lowercase letter.<br/> - Avoid ending with a period (`.`).<br/> - Limited to **50 characters**. - Written in **English**. |
| Element | Requirement | Description |
|--------------|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `<type>` | **Required** | Describes the purpose of the commit. Examples: `feat`, `fix`, `docs`, `style`, `refactor`, `test` |
| `<scope>` | **Optional** | Specifies the affected module, file, or functionality. Limited to **20 characters** (e.g., `auth`, `header`). |
| `<subject>` | **Required** | A concise summary of the changes<br/> - Starts with a lowercase letter<br/> - Avoid ending with a period (.)<br/> - Limited to **50 characters**<br/> - Must contain only English characters, numbers, and basic punctuation (!@#$%^&*(),.?":{}|<>_-)<br/> - Cannot be empty |



Expand Down

0 comments on commit dc9376b

Please sign in to comment.