Skip to content

Conversation

@rohitthakur2590
Copy link
Collaborator

SUMMARY

Add GitHub PR and issue templates to improve code review quality and process

Description

This PR adds comprehensive PR and issue templates to the cisco.iosxr collection to improve code review quality and address process improvements.

Type of Change

  • New feature (non-breaking change which adds functionality)
  • Development environment change

Component Name

GitHub templates (.github/PULL_REQUEST_TEMPLATE.md, .github/ISSUE_TEMPLATE/)

Changes Made

PR Templates

  • Added comprehensive PR templates for all three collections (cisco.iosxr)
  • Templates include:
    • Self-review checklist (addresses PR review quality concerns)
    • Acceptance criteria verification section (ensures ticket requirements are met)
    • Explicit checkbox to remove commented code (prevents merging commented code)
    • Component name field (from old template)
    • Command output/logs section (from old template)
    • New module option in type of change
    • Networking-specific fields (INX-OS versions, hardware platforms)

Issue Templates

  • Added bug report template
  • Added feature request templates
  • Added config.yml for issue template chooser
  • Templates include networking-specific fields:
    • NX-OS version fields
    • Hardware platform fields
    • Component checkboxes (Module, Action Plugin, Connection Plugin, etc.)

Related Issue

Addresses process improvements discussed in team retrospective:

  • PR review quality
  • Merging PRs without reviews
  • Merging PRs with commented code
  • Not reviewing acceptance criteria
  • Target end dates for tickets

Self-Review Checklist

  • I have performed a self-review of my code
  • I have removed all commented code (no commented code should be merged)
  • I have updated documentation where needed
  • I have tested the changes in my local environment
  • I have reviewed the acceptance criteria for related tickets

Testing Instructions

Steps to Test

  1. Create a new PR in any of the three collections - the PR template should auto-populate
  2. Create a new issue - the issue template chooser should appear
  3. Verify all fields are appropriate for each collection (IOS-XR vs IOS vs NX-OS)

Expected Results

  • PR templates appear when creating new PRs
  • Issue templates appear when creating new issues
  • All YAML files pass ansible-lint checks
  • Templates are collection-specific (correct OS versions, module names, etc.)

Additional Context

These templates are based on the ansible.platform collection templates but adapted for networking collections with:

  • Platform-specific version fields
  • Hardware platform information
  • Collection-specific module naming conventions
  • Components relevant to each collection (e.g., HTTP API plugin for NX-OS)

The templates help ensure:

  • All PRs include acceptance criteria verification
  • Commented code is explicitly removed before merging
  • Reviewers have necessary information (OS versions, hardware platforms)
  • Self-review checklist improves initial PR quality

Signed-off-by: rohitthakur2590 <[email protected]>
@rohitthakur2590 rohitthakur2590 added the skip-changelog A trivial PR not requiring a change log for users label Dec 1, 2025
@rohitthakur2590 rohitthakur2590 marked this pull request as ready for review December 1, 2025 08:07
@sonarqubecloud
Copy link

sonarqubecloud bot commented Dec 1, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

safe to test skip-changelog A trivial PR not requiring a change log for users

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants