Skip to content

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

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

[chore/github]: Standardize GitHub PR description template#385
oleksandrivantsiv wants to merge 1 commit into
sonic-net:masterfrom
oleksandrivantsiv:pr-template-standardization

Conversation

@oleksandrivantsiv
Copy link
Copy Markdown
Contributor

Description of PR

Summary:
Align this repository's GitHub PR description template with the canonical
template used in sonic-buildimage,
so contributors see the same prompts (Description of PR, Type of change,
Approach, Documentation) everywhere across SONiC.

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

Fixes # (issue)

Type of change

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

Approach

What is the motivation for this PR?

PR description templates across SONiC repositories have drifted from the
canonical sonic-buildimage template over time. 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?

  • Replaced .github/pull_request_template.md with the canonical sonic-buildimage template.
  • 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).

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.

@mssonicbld
Copy link
Copy Markdown

/azp run

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 1 pipeline(s).

Replace legacy templates with unified pull_request_template.md
(description, type, approach, documentation).

Signed-off-by: Oleksandr Ivantsiv <oivantsiv@nvidia.com>
@oleksandrivantsiv oleksandrivantsiv force-pushed the pr-template-standardization branch from f4f8a7b to 185ad62 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
Contributor 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 #385
sonic-net/sonic-linkmgrd sonic-net/sonic-linkmgrd#340
sonic-net/sonic-linux-kernel 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

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