-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add RFC for conventional commits (#2)
- Loading branch information
1 parent
9c13722
commit fade00f
Showing
1 changed file
with
17 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# RFC-004: Conventional Commits | ||
|
||
## Summary | ||
|
||
Adopting conventional commits to enhance the readability and consistency of commit messages. | ||
|
||
## Problem | ||
|
||
Commit messages frequently lack readability and consistency, making them challenging to understand. | ||
|
||
Automatically generating release notes becomes difficult without adhering to a consistent commit format. | ||
|
||
## Proposal | ||
|
||
Implement [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) to improve the readability of commit messages. | ||
|
||
Initially, enforce conventional commit standards using a GitHub workflow. Over time, transition to using a GitHub ruleset for enforcement. |