From 3b4c8642e2f1a141200befa5da6bb35236e1c8b2 Mon Sep 17 00:00:00 2001 From: Kunal Marwaha Date: Wed, 3 Dec 2025 02:36:54 -0500 Subject: [PATCH] Update commit message guidelines in contribute.md Clarify the format for pull request titles and descriptions, including examples and explanations. --- templates/contribute/commit.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/templates/contribute/commit.md b/templates/contribute/commit.md index dc6e87d185..040d0ad7f9 100644 --- a/templates/contribute/commit.md +++ b/templates/contribute/commit.md @@ -4,18 +4,19 @@ We are using the following convention for writing pull request titles and descri ## Format -Note: "Title:" and "Description:" do not actually appear - +The title of the PR will be the title of the commit after the PR is merged. It should have the following format: ```markdown - Title: (): +``` - Description: +The description of the PR, before the `---`, will be the description of the commit after the PR is merged. It should have the following format: +```markdown