docs: Enhance pull request template with guidelines#448
docs: Enhance pull request template with guidelines#448
Conversation
Updated the pull request template to include acceptance requirements and guidelines for naming pull request titles.
github-project-automation
bot
moved this to In progress
in 🐍 Python SDK - Keep on par with the API
There was a problem hiding this comment.
Pull request overview
Updates the repository’s pull request template to provide clearer contribution/formatting guidance and add disclosure sections for PR metadata.
Changes:
- Adds an “Acceptance Requirements” note and a PR title naming scheme with allowed
types. - Updates the Description section prompt text.
- Adds an LLM usage disclosure section and revises the related-issues section.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - `l10n`, for Localization and translation updates | ||
| - `taxonomy`, for Changes to product categories and tags taxonomy |
There was a problem hiding this comment.
The PR title type list includes l10n and taxonomy, but the repo’s Semantic PR check runs amannn/action-semantic-pull-request@v6 without any type configuration. That action’s defaults typically only allow the standard conventional-commit types, so these extra types may cause PRs to fail CI. Either remove unsupported types from this template or add an explicit configuration for the semantic PR action so the template matches what CI enforces.
| - `l10n`, for Localization and translation updates | |
| - `taxonomy`, for Changes to product categories and tags taxonomy |
| - Fixes #[ISSUE NUMBER] No newline at end of file | ||
| ### Related issue(s) and discussion | ||
| <!-- Please add the issue number this issue will close, that way, once your pull request is merged, the issue will be closed as well --> | ||
| - Fixes: <!-- #1 Note: you can also use Closes: --> |
There was a problem hiding this comment.
The “Fixes” line is currently rendered as just Fixes: with the example issue number inside an HTML comment, which makes it easy to forget the required Fixes #123/Closes #123 syntax and prevents auto-closing if left unchanged. Consider making the placeholder explicit (e.g., Fixes #<issue-number>) so the default text is already valid GitHub closing-keyword format.
| - Fixes: <!-- #1 Note: you can also use Closes: --> | |
| - Fixes #<issue-number> <!-- Note: you can also use Closes instead of Fixes --> |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
docs: Enhance pull request template with guidelines