-
Notifications
You must be signed in to change notification settings - Fork 66
Description
What you would like to be added?
Currently, the PR title check workflow (check-pr-title.yaml) only allows the following types:
- chore
- fix
- feat
- revert
Due to this, documentation-related PRs with the type 'docs' fail the PR title check. This creates confusion for contributors submitting documentation updates.
Proposed Change:
- Add 'docs' as a valid type in the PR title check workflow.
- Ensure that contributors submitting documentation PRs do not face title validation failures.
Benefits:
- Smooth PR submission for documentation updates.
- Clear guidance for new contributors.
- Reduce unnecessary failures in CI due to PR title.
Related Work:
- PR chore(trainer): add trainerclient and optimizerclient sections #190 (update AGENTS.md with TrainerClient and OptimizerClient) failed PR title check because 'docs' type was missing.
Why is this needed?
Documentation PRs are critical for keeping Kubeflow SDK clear and up-to-date for contributors.
Currently, the PR title validation blocks PRs that use 'docs' in their title because 'docs' is not included in the allowed types. This creates unnecessary friction for contributors, especially new ones, and can delay important documentation updates.
Adding 'docs' as a valid type ensures that documentation PRs pass the title check smoothly and encourages contributors to maintain high-quality documentation without facing CI failures.
Love this feature?
Give it a 👍 We prioritize the features with most 👍