From fade00f1f35b57e02208eb811833dded4fe798e7 Mon Sep 17 00:00:00 2001 From: JoshuaLicense Date: Fri, 9 Feb 2024 09:32:55 +0000 Subject: [PATCH] docs: add RFC for conventional commits (#2) --- docs/rfc/rfc-004-conventional-commits.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs/rfc/rfc-004-conventional-commits.md diff --git a/docs/rfc/rfc-004-conventional-commits.md b/docs/rfc/rfc-004-conventional-commits.md new file mode 100644 index 0000000000..e15b861a39 --- /dev/null +++ b/docs/rfc/rfc-004-conventional-commits.md @@ -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.