Skip to content

Commit

Permalink
docs: add RFC for conventional commits (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshuaLicense authored Feb 9, 2024
1 parent 9c13722 commit fade00f
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/rfc/rfc-004-conventional-commits.md
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.

0 comments on commit fade00f

Please sign in to comment.