Skip to content

[docs] Update copilot instructions: SmartSwitch architecture and PR template#23142

Merged
lihuay merged 1 commit intosonic-net:masterfrom
vvolam:update-copilot-ins
Mar 21, 2026
Merged

[docs] Update copilot instructions: SmartSwitch architecture and PR template#23142
lihuay merged 1 commit intosonic-net:masterfrom
vvolam:update-copilot-ins

Conversation

@vvolam
Copy link
Contributor

@vvolam vvolam commented Mar 19, 2026

Description of PR

Summary:
Update .github/copilot-instructions.md to:

  1. Expand the Architecture section with SmartSwitch / DPU directory structure (tests/smartswitch/, ansible/golden_config_db/), including subtree details for common utilities, conftest, platform tests, and golden config DB files.
  2. Add a new SmartSwitch / DPU Concepts subsection covering DPU, NPU, midplane, dark mode, duthost/dpuhosts, device_utils_dpu.py, DPU_CRITICAL_PROCESS_SKIP, golden config DB, and gNOI.
  3. Add a PR Description Template subsection to the PR Guidelines, requiring use of .github/PULL_REQUEST_TEMPLATE.md for all PRs.

Type of change

  • Testbed and Framework(new/improvement)

Back port request

  • 202205
  • 202305
  • 202311
  • 202405
  • 202411
  • 202505
  • 202511

Approach

What is the motivation for this PR?

The copilot instructions lacked SmartSwitch / DPU context, making it harder for Copilot to give accurate suggestions when working in the tests/smartswitch/ area. Also, PRs were being created without the required template structure.

How did you do it?

  • Expanded the repo architecture tree with tests/smartswitch/ and ansible/golden_config_db/ entries.
  • Added a SmartSwitch / DPU Concepts section to document key terms, fixtures, and conventions.
  • Added a PR Description Template section referencing PULL_REQUEST_TEMPLATE.md.

How did you verify/test it?

Reviewed the updated instructions against the actual file structure

Any platform specific information?

N/A

Supported testbed topology if it's a new test case?

N/A — documentation only.

Documentation

Updates .github/copilot-instructions.md — the Copilot workspace instructions file.

Signed-off-by: Vasundhara Volam [email protected]

@mssonicbld
Copy link
Collaborator

/azp run

@azure-pipelines
Copy link

Azure Pipelines could not run because the pipeline triggers exclude this branch/path.

Always use .github/PULL_REQUEST_TEMPLATE.md when creating PRs.
Fill in every section and mark appropriate checkboxes.

Signed-off-by: Vasundhara Volam <[email protected]>
@vvolam vvolam force-pushed the update-copilot-ins branch from 3689a26 to caba84f Compare March 19, 2026 18:08
@mssonicbld
Copy link
Collaborator

/azp run

@azure-pipelines
Copy link

Azure Pipelines could not run because the pipeline triggers exclude this branch/path.

@lihuay lihuay merged commit 1633228 into sonic-net:master Mar 21, 2026
6 checks passed
vrajeshe pushed a commit to vrajeshe/sonic-mgmt that referenced this pull request Mar 23, 2026
…#23142)

Always use .github/PULL_REQUEST_TEMPLATE.md when creating PRs.
Fill in every section and mark appropriate checkboxes.

Signed-off-by: Vasundhara Volam <[email protected]>
Signed-off-by: Venkata Gouri Rajesh Etla <[email protected]>
ravaliyel pushed a commit to ravaliyel/sonic-mgmt that referenced this pull request Mar 27, 2026
…#23142)

Always use .github/PULL_REQUEST_TEMPLATE.md when creating PRs.
Fill in every section and mark appropriate checkboxes.

Signed-off-by: Vasundhara Volam <[email protected]>
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