From 389ad70c2e1d598eba5cfd8392fdb1b1efa55ab1 Mon Sep 17 00:00:00 2001 From: "bobo.yang" Date: Fri, 7 Mar 2025 11:39:33 +0800 Subject: [PATCH] docs: Add example output to commit message prompts - Added example commit message format to GitHub prompt file - Added example commit message format to GitLab prompt file - Demonstrates proper structure with feature type and API details --- merico/github/commit/diffCommitMessagePrompt.txt | 8 ++++++++ merico/gitlab/commit/diffCommitMessagePrompt.txt | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/merico/github/commit/diffCommitMessagePrompt.txt b/merico/github/commit/diffCommitMessagePrompt.txt index 4d228a0..e824356 100644 --- a/merico/github/commit/diffCommitMessagePrompt.txt +++ b/merico/github/commit/diffCommitMessagePrompt.txt @@ -39,3 +39,11 @@ Related issue: {__ISSUE__} Utilize the provided format to craft a commit message that adheres to the stipulated criteria. +example output: +```commit +feature: add update user info API + +- add post method api /user/update +- implement update user info logic +``` + diff --git a/merico/gitlab/commit/diffCommitMessagePrompt.txt b/merico/gitlab/commit/diffCommitMessagePrompt.txt index 4d228a0..e824356 100644 --- a/merico/gitlab/commit/diffCommitMessagePrompt.txt +++ b/merico/gitlab/commit/diffCommitMessagePrompt.txt @@ -39,3 +39,11 @@ Related issue: {__ISSUE__} Utilize the provided format to craft a commit message that adheres to the stipulated criteria. +example output: +```commit +feature: add update user info API + +- add post method api /user/update +- implement update user info logic +``` +