Skip to content

[chore/github]: Standardize GitHub PR description template - #579

Open
oleksandrivantsiv wants to merge 1 commit into
sonic-net:masterfrom
oleksandrivantsiv:pr-template-standardization
Open

oleksandrivantsiv wants to merge 1 commit into
sonic-net:masterfrom
oleksandrivantsiv:pr-template-standardization

Conversation

@oleksandrivantsiv

@oleksandrivantsiv oleksandrivantsiv commented May 21, 2026 •

Copy link
Copy Markdown
Collaborator

Description of PR

Summary:
Add a GitHub PR description template to this repository: the standardized
template already merged in sonic-swss and sonic-dash-ha, so contributors
see the same prompts (Description of PR, Type of change, Approach,
Documentation) everywhere across SONiC. For this repository the template also
asks for the patch upstreaming plan/status when new patches are added.

Also update .github/copilot-instructions.md so AI-assisted PR descriptions
reference the new template sections.

Type of change

  • Bug fix
  • New feature
  • Refactor / cleanup
  • Documentation update
  • Test improvement

Approach

What is the motivation for this PR?

This repository has no PR description template. A single shared structure
makes reviews predictable: contributors see the same prompts everywhere, and
reviewers can locate the same information in the same place across submodules.

How did you do it?

  • Added .github/pull_request_template.md: the standardized template from sonic-swss and sonic-dash-ha, plus a "Patch upstreaming plan/status (if new patches are being added)" question under Approach.
  • Updated .github/copilot-instructions.md so the "PR description template" guidance lists the sections defined by the new template (Description of PR, Type of change, Approach, Documentation), including the upstreaming question.

How did you verify/test it?

No functional changes: only files under .github/ are touched. Verified by
rendering the new template on GitHub when opening this PR and confirming all
sections appear correctly.

Any platform specific information?

None.

Documentation

N/A, process/template change only.

@oleksandrivantsiv
oleksandrivantsiv requested a review from a team as a code owner May 21, 2026 22:14
@mssonicbld

Copy link
Copy Markdown

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@oleksandrivantsiv
oleksandrivantsiv force-pushed the pr-template-standardization branch from c077717 to 0f16869 Compare May 21, 2026 22:34
@mssonicbld

Copy link
Copy Markdown

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@oleksandrivantsiv

Copy link
Copy Markdown
Collaborator Author

Related PRs

This PR is part of a coordinated rollout to standardize the GitHub PR description template across SONiC repositories. The same change is being applied via the following PRs:

Repository PR
sonic-net/sonic-bmp sonic-net/sonic-bmp#35
sonic-net/sonic-dash-api sonic-net/sonic-dash-api#69
sonic-net/sonic-dash-ha sonic-net/sonic-dash-ha#169
sonic-net/sonic-dbsyncd sonic-net/sonic-dbsyncd#81
sonic-net/sonic-dhcp-relay sonic-net/sonic-dhcp-relay#111
sonic-net/sonic-dhcpmon sonic-net/sonic-dhcpmon#77
sonic-net/sonic-genl-packet sonic-net/sonic-genl-packet#8
sonic-net/sonic-gnmi sonic-net/sonic-gnmi#680
sonic-net/sonic-host-services sonic-net/sonic-host-services#385
sonic-net/sonic-linkmgrd sonic-net/sonic-linkmgrd#340
sonic-net/sonic-linux-kernel #579
sonic-net/sonic-mgmt-common sonic-net/sonic-mgmt-common#222
sonic-net/sonic-mgmt-framework sonic-net/sonic-mgmt-framework#160
sonic-net/sonic-platform-common sonic-net/sonic-platform-common#671
sonic-net/sonic-platform-daemons sonic-net/sonic-platform-daemons#819
sonic-net/sonic-platform-pdk-pde sonic-net/sonic-platform-pdk-pde#39
sonic-net/sonic-py-swsssdk sonic-net/sonic-py-swsssdk#159
sonic-net/sonic-restapi sonic-net/sonic-restapi#186
sonic-net/sonic-snmpagent sonic-net/sonic-snmpagent#376
sonic-net/sonic-stp sonic-net/sonic-stp#89
sonic-net/sonic-swss sonic-net/sonic-swss#4596
sonic-net/sonic-swss-common sonic-net/sonic-swss-common#1193
sonic-net/sonic-utilities sonic-net/sonic-utilities#4561
sonic-net/sonic-ztp sonic-net/sonic-ztp#78

@saiarcot895

Copy link
Copy Markdown
Contributor

#572 is also open for this purpose. Which one should be used?

@liat-grozovik

Copy link
Copy Markdown
Collaborator

@saiarcot895 you please suggest who can review/approve?

@saiarcot895

Copy link
Copy Markdown
Contributor

#572 is also open for this purpose. Which one should be used?

@liat-grozovik Please see my comment above.

Add the standardized pull_request_template.md (description, type,
approach, documentation) already used in sonic-swss and sonic-dash-ha,
with a patch upstreaming plan/status question for new kernel patches.
List the template sections in copilot-instructions.md.

Signed-off-by: Oleksandr Ivantsiv <oivantsiv@nvidia.com>
@oleksandrivantsiv
oleksandrivantsiv force-pushed the pr-template-standardization branch from 0f16869 to 4224919 Compare October 7, 2026 22:12
@mssonicbld

Copy link
Copy Markdown

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 1 pipeline(s).

@oleksandrivantsiv

Copy link
Copy Markdown
Collaborator Author

@saiarcot895 This one. I added the patch upstreaming plan/status question you asked for in #572 and closed #572. Please review.

@oleksandrivantsiv

Copy link
Copy Markdown
Collaborator Author

/azpw retry

@mssonicbld

Copy link
Copy Markdown

Retrying failed(or canceled) jobs...

@mssonicbld

Copy link
Copy Markdown

Retrying failed(or canceled) stages in build 1241671:

✅Stage Build:

  • Job vs-amd64 (Secure boot False): retried.
  • Job vs-amd64 (Secure boot True): retried.

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.

4 participants