Skip to content

Enforce PR template compliance and require related issue/discussion reference #4227

Closed

Description

@Yicong-Huang

Task Summary

Many pull requests are not following the PR template well, especially the "Any related issues, documentation, discussions?" section. In multiple PRs, there is no linked issue/discussion (e.g., #1234), which makes review and traceability harder.

Why this is a bad practice

  • It weakens traceability: reviewers cannot easily connect code changes to the original problem statement or decision context.
  • It slows down review: missing context forces reviewers/maintainers to ask follow-up questions and increases review cycle time.
  • It hurts project hygiene: release notes, changelog curation, and future maintenance become harder without issue linkage.
  • It reduces accountability: unclear ownership/scope makes regressions and follow-up fixes harder to track.

Priority

P1 – High

Task Type

  • Code Implementation
  • Documentation
  • Refactor / Cleanup
  • Testing / QA
  • DevOps / Deployment

Activity

  1. self-assigned this
    on Feb 20, 2026
  2. carloea2 commented on Feb 25, 2026

    @carloea2
    Contributor

    Hi, one question, for a PR with no logical change and few changes (even 2 chars), an issue is still a good practice?

  3. chenlica commented on Feb 25, 2026

    @chenlica
    Contributor

    We have an ongoing discussion #4228 about this topic. We will conclude there first.

  4. locked and limited conversation to collaborators on Feb 28, 2026
  5. converted this issue into a discussion #4246 on Feb 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions