Skip to content

doc: add pull request template#9

Closed
hrntknr wants to merge 2 commits intomainfrom
feat/add-pr-template
Closed

doc: add pull request template#9
hrntknr wants to merge 2 commits intomainfrom
feat/add-pr-template

Conversation

@hrntknr
Copy link
Copy Markdown
Member

@hrntknr hrntknr commented Aug 17, 2025

Summary

  • Add GitHub pull request template for consistent PR format
  • Include sections for summary, change type, and related issues
  • Use bullet-point format for better readability

- Add comprehensive PR template with bullet-point summary format
- Include checkboxes for common change types
- Provide section for related issues
Copilot AI review requested due to automatic review settings August 17, 2025 17:17
Copy link
Copy Markdown
Contributor

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

Adds a GitHub pull request template to standardize the format and content of pull requests across the repository.

  • Creates a new PR template with structured sections for summary, change type selection, and issue linking
  • Implements checkbox format for change type categorization to improve clarity
  • Establishes consistent documentation practices for future pull requests

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

Comment thread .github/pull_request_template.md Outdated

-
-
-
Copy link

Copilot AI Aug 17, 2025

Choose a reason for hiding this comment

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

The summary section contains empty bullet points without placeholder text or guidance. Consider adding placeholder text like '- Brief description of what this PR accomplishes' to help users understand what information to provide.

Suggested change
-
- Brief description of what this PR accomplishes
- Relevant context or background information
- Any important implementation details or notes

Copilot uses AI. Check for mistakes.
Comment thread .github/pull_request_template.md Outdated

## Related Issues

Closes #(issue number)
Copy link

Copilot AI Aug 17, 2025

Choose a reason for hiding this comment

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

[nitpick] The issue reference format could be clearer. Consider using a more explicit placeholder like 'Closes #123' or 'Fixes #123' and adding guidance about when this section should be used (e.g., 'Leave blank if no related issues').

Suggested change
Closes #(issue number)
<!-- Example: Closes #123 or Fixes #456. Leave blank if no related issues. -->

Copilot uses AI. Check for mistakes.
@hrntknr hrntknr changed the title feat: add pull request template doc: add pull request template Aug 17, 2025
@hrntknr hrntknr closed this Aug 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants