Adding a PR Template for Localization Branches.
AbdelatifAitBara opened this issue · comments
This is a Feature Request
What would you like to be added
I'm part of the Arabic localization team, and I'd like to add a pull_request_template.md file to our branch dev-1.29-ar.1.
If other localization teams are amenable to the following template, it would be beneficial to include it in their respective branches as well.
Why is this needed
This will have many advantages; I'll mention a few below:
- Efficient Reviews.
- Traceability.
- Visual Context.
- Standardization.
Comments
This is the PR Template:
Description
[Provide a clear and concise description of the changes made in this PR.]
Related Issue
[Mention the issue number or link to the related issue that this PR addresses.]
Preview of Edited Page(s)
[Provide a link to a preview of the edited page(s) for easier review.]
Checklist
- I have tested the changes locally and they are working as expected.
- I have followed the coding style guidelines.
- I have squashed my commits into a single commit with a clear commit message.
Additional Information
[Provide any additional information or context that might be helpful for the reviewers and approvers.]
This issue is currently awaiting triage.
SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.
The triage/accepted label can be added by org members by writing /triage accepted in a comment.
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.
@AbdelatifAitBara: The label(s) language/pt-br, language/zh-cn cannot be applied, because the repository doesn't have them.
In response to this:
/language it
/language de
/language es
/language hi
/language id
/language ja
/language ko
/language pl
/language pt-br
/language ru
/language uk
/language vi
/language zh-cn
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.
@AbdelatifAitBara: The label(s) language/cn cannot be applied, because the repository doesn't have them.
In response to this:
/language bn
/language pt
/language cn
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.
If you add a pull request template, that localization branch would then not be mergeable into main. I don't recommend it.
We could change the main pull request template to mention that extra detail is needed for localization work, and you could then cherry-pick that change. I think that'd be OK.
Here's the existing template. What's not right about it?
/remove-language ar
/remove-language bn
/remove-language de
/remove-language es
/remove-language fr
/remove-language hi
/remove-language id
/remove-language it
/remove-language ja
/remove-language ko
/remove-language pl
/remove-language pt
/remove-language ru
/remove-language uk
/remove-language vi
/remove-language zh
/area localization
Sure, we'll be happy to use that one and maybe adding some extra details as you said.
The problem we are facing now is that when we try to open a PR on our branch dev-1.29-ar.1, we don't get any template, even the one you mentioned.
Do you see something like this when you try to open a PR?
That's what I saw when I tried.
If not, I wonder why not?
Now yes, perhaps when I opened my first PR, I did not notice it. I apologize for that.
So do you think that we could add some more details to this one? As :
Related Issue
[Mention the issue number or link to the related issue that this PR addresses.]
Preview of Edited Page(s)
[Provide a link to a preview of the edited page(s) for easier review.]
Checklist
- I have tested the changes locally and they are working as expected.
- I have followed the coding style guidelines.
- I have squashed my commits into a single commit with a clear commit message.