Skip to content

docs(github): move PR template to GitHub idiomatic location #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 17, 2025

Conversation

KemingHe
Copy link
Owner

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

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
@KemingHe KemingHe requested a review from Copilot August 17, 2025 02:11
@KemingHe KemingHe self-assigned this Aug 17, 2025
@KemingHe KemingHe added the documentation Improvements or additions to documentation label Aug 17, 2025
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR standardizes the repository's GitHub workflows by moving the PR template to GitHub's expected location and updating AI prompts to support proper multi-issue linking format.

  • Move PR template from non-standard PULL_REQUEST_TEMPLATE/ directory to standard .github/ location
  • Update commit message and PR generation prompts to clarify multi-issue linking guidelines

Reviewed Changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.

File Description
prompts/prompt-pull-request-gen.md Added guidance for separate "closes #[issue-number]" statements per resolved issue
prompts/prompt-commit-msg-gen.md Updated issue linking format to support multiple issues with separate "closes" statements
Comments suppressed due to low confidence (1)

prompts/prompt-commit-msg-gen.md:58

  • There's an extra dash in the bullet point. It should be "- Issue linking" not "-- Issue linking".
- **Content**: Only include sections with meaningful content, use dash bullets with no redundancy between items

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@KemingHe KemingHe merged commit cfd5a8c into main Aug 17, 2025
4 checks passed
@KemingHe KemingHe deleted the docs/update-common-devx/KemingHe branch August 17, 2025 02:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant