From fe4a0daa82dee2c5ee34e7257dd248ad3f6844c0 Mon Sep 17 00:00:00 2001 From: Keming He Date: Sat, 16 Aug 2025 22:11:19 -0400 Subject: [PATCH] docs(github): move PR template to GitHub idiomatic location CHANGES - Move PR template from PULL_REQUEST_TEMPLATE/ to root .github/ - Update commit message prompt with multi-issue linking format - Update PR generation prompt with issue linking guidelines IMPACT - GitHub will automatically detect PR template in standard location - Improved AI prompt consistency with KemingHe/common-devx standards --- .github/{PULL_REQUEST_TEMPLATE => }/pull_request_template.md | 0 prompts/prompt-commit-msg-gen.md | 3 ++- prompts/prompt-pull-request-gen.md | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) rename .github/{PULL_REQUEST_TEMPLATE => }/pull_request_template.md (100%) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/pull_request_template.md similarity index 100% rename from .github/PULL_REQUEST_TEMPLATE/pull_request_template.md rename to .github/pull_request_template.md diff --git a/prompts/prompt-commit-msg-gen.md b/prompts/prompt-commit-msg-gen.md index 1e6f4ed..e344fd2 100644 --- a/prompts/prompt-commit-msg-gen.md +++ b/prompts/prompt-commit-msg-gen.md @@ -36,6 +36,7 @@ Write final commit message and return in plaintext code block. type(scope): brief description in imperative mood closes #[issue-number] (if applicable) +closes #[issue-number] (repeat for each resolved issue) CHANGES - Key change 1 @@ -55,7 +56,7 @@ TECHNICAL NOTES - **Title**: Max 50 characters, imperative mood ("add", "fix", "update") - **Content**: Only include sections with meaningful content, use dash bullets with no redundancy between items -- **Issue linking**: Only include "closes #X" for actual issue resolution +- **Issue linking**: Only include "closes #X" for actual issue resolution, use separate "closes" statements for each issue ## EXAMPLES diff --git a/prompts/prompt-pull-request-gen.md b/prompts/prompt-pull-request-gen.md index 36b5cab..ee62f2e 100644 --- a/prompts/prompt-pull-request-gen.md +++ b/prompts/prompt-pull-request-gen.md @@ -36,6 +36,7 @@ You are a senior software engineer creating pull request descriptions that commu - **Analysis depth**: Analyze feature branch against main using git commands and GitHub MCP tools - **Content accuracy**: Preserve implementation details, performance impacts, architectural decisions - **Business context**: Connect technical changes to business value and user impact +- **Issue linking**: Use separate "closes #[issue-number]" statements for each resolved issue to ensure proper GitHub recognition ## OUTPUT FORMAT