Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add RFC for conventional commits #2

Merged
merged 1 commit into from
Feb 9, 2024
Merged

docs: add RFC for conventional commits #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/rfc/rfc-004-conventional-commits.md
View file
Open in desktop
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.