Skip to content

Conversation

@gdlg
Copy link
Contributor

@gdlg gdlg commented Aug 27, 2025

This pull request updates the .github/pull_request_template.md file to improve the clarity and usefulness of pull request descriptions and checklists. The changes focus on guiding contributors to provide better summaries and references, streamlining the checklist, and removing redundant sections.

Improvements to PR description guidance:

  • Added instructions encouraging contributors to provide a more comprehensive summary, including relevant facts, design choices, and testing procedures, and clarified how to reference related issues and pull requests.

Checklist and documentation updates:

  • Simplified the checklist by merging unit and integration test items, and clarified requirements for documenting manual tests and changelog updates.
  • Removed redundant license section and example license header, streamlining the template for easier use.

Summary

How to test

Checklist

  • I have added unit tests to cover my changes.​
  • I have added integration tests to cover my changes.​
  • I have added the description of my changes into CHANGELOG.​
  • I have updated the documentation accordingly

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.
  • I have updated the license header for each file (see an example below).
# Copyright (C) 2025 Intel Corporation
#
# SPDX-License-Identifier: MIT

gdlg added 2 commits August 27, 2025 19:06
Signed-off-by: Grégoire Payen de La Garanderie <[email protected]>
If we start the PR template description on the first line, then the
author has to manually add couple of newline. For instance, when Copilot
generate a summary, it does not add a newline and we end up with PR
starting at the end of the last line of the summary instead of a
new line. It's a bit messy.

Signed-off-by: Grégoire Payen de La Garanderie <[email protected]>
@gdlg gdlg requested a review from AlbertvanHouten August 27, 2025 18:15
@gdlg gdlg merged commit f274c6d into develop Aug 29, 2025
16 checks passed
@gdlg gdlg deleted the gppayend/pr-template branch September 25, 2025 11:43
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.

3 participants