From 56bb4f1c05868482be1f8cd9eb74780a2575d9a7 Mon Sep 17 00:00:00 2001 From: Ken Matsui <26405363+ken-matsui@users.noreply.github.com> Date: Tue, 7 Jan 2025 19:18:23 -0500 Subject: [PATCH] CONTRIBUTING.md: improve --- CONTRIBUTING.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 09178c66c..2b46de53d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -119,11 +119,14 @@ mkdocs build --strict ## Commit Message -We generally follow the +Read [Git Contribution Guidelines](https://git-scm.com/docs/SubmittingPatches#describe-changes). -- **First Line**: `component: description of the patch` in all lowercase. -- **Body**: Explain your change in 2-3 paragraphs: +In a nutshell: + +- **First Line**: `component: description of the patch` in all lowercase + unless it's in a cap in the code. +- **Body**: In 2-3 paragraphs: 1. the current problem you want to solve 2. justification of your change 3. if any, alternative solutions considered but discarded