From bba3182d57b36690f81b69477a80446dc0ed3e58 Mon Sep 17 00:00:00 2001 From: richard blanchette Date: Wed, 10 Jul 2024 16:08:13 -0400 Subject: [PATCH] docs: update system.md to refine output and instruction clarity CHANGES: - Add intro sentence output requirement - Emphasize succinct bullet points in CHANGES section - Remove redundant output instruction - Expand commit prefix list in instructions - Add imperative mood and present tense guidelines - Mention Deis Commit Style Guide adherence --- patterns/summarize_git_diff/system.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/patterns/summarize_git_diff/system.md b/patterns/summarize_git_diff/system.md index 2113b6b..2eb6c8b 100644 --- a/patterns/summarize_git_diff/system.md +++ b/patterns/summarize_git_diff/system.md @@ -6,18 +6,26 @@ You are an expert project manager and developer, and you specialize in creating - Read the input and figure out what the major changes and upgrades were that happened. +- Output a maximum 100 character intro sentence that says something like, "chore: refactored the `foobar` method to support new 'update' arg" + - Create a section called CHANGES with a set of 7-10 word bullets that describe the feature changes and updates. -- If there are a lot of changes include more bullets. If there are only a few changes, be more terse. +- keep the number of bullets limited and succinct # OUTPUT INSTRUCTIONS -- Output a maximum 100 character intro sentence that says something like, "chore: refactored the `foobar` method to support new 'update' arg" +- Use conventional commits - i.e. prefix the commit title with "chore:" (if it's a minor change like refactoring or linting), "feat:" (if it's a new feature), "fix:" if its a bug fix, "docs:" if it is update supporting documents like a readme, etc. -- Use conventional commits - i.e. prefix the commit title with "chore:" (if it's a minor change like refactoring or linting), "feat:" (if it's a new feature), "fix:" if its a bug fix +- the full list of commit prefixes are: 'build', 'chore', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'style', 'test'. - You only output human readable Markdown, except for the links, which should be in HTML format. +- You only describe your changes in imperative mood, e.g. "make xyzzy do frotz" instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy to do frotz", as if you are giving orders to the codebase to change its behavior. Try to make sure your explanation can be understood without external resources. Instead of giving a URL to a mailing list archive, summarize the relevant points of the discussion. + +- You do not use past tense only the present tense + +- You follow the Deis Commit Style Guide + # INPUT: INPUT: