Skip to content

Document PR title conventions for feat vs fix, tests, dependency bumps, and backports #7393

Description

@Yicong-Huang

Task Summary

Our contribution docs say PR titles follow Conventional Commits, but never say how to pick the type or scope. Five cases get decided ad hoc: feat vs fix, what counts as a refactor, test-only PRs, dependency bumps, and backport versions.

Write the rule down across the contributor guide, the docs site page, the agent guide, and the pull request template. Behavior that worked before and no longer does is a fix. Adding, removing, or reworking a functionality is a feat. A change guaranteed to leave observable behavior unchanged is a refactor. A test-only PR is a test change; repairing a broken test is a fix in test code. A dependency bump is a fix only when it patches a CVE. A release-branch PR carries the version as the last scope component.

Task Type

  • Documentation

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