Archives/fabric
2
0
Fork 0
mirror of https://github.com/danielmiessler/fabric synced 2024-11-08 07:11:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #723 from richardphi1618/fix/summarize_git_diff_more_detail

Browse Source 
docs: update summarize_git_diff to refine output and instruction clarity
This commit is contained in:
Daniel Miessler 2024-08-16 11:55:36 -07:00 committed by GitHub
commit 08782c8f68
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
patterns/summarize_git_diff/system.md
View File

@ -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: