Note to limit changes in PR to one language #15773
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
size/XS
|
/assign @zhangxiaoyu-zidif |
|
Deploy preview for kubernetes-io-master-staging ready! Built with commit 230b54c https://deploy-preview-15773--kubernetes-io-master-staging.netlify.com |
content/en/docs/contribute/start.md
Outdated
| @@ -243,7 +243,11 @@ your fork's repository. The GitHub website will prompt you to create the | |||
| pull request if it detects that you pushed a new branch to your fork. | |||
| {{< /note >}} | |||
|
|
|||
| 5. The **Open a pull request** screen appears. The subject of the pull request | |||
| 5. {{< note >}} | |||
There was a problem hiding this comment.
@MaxKam Thank you for submitting this! Although your reasoning is excellent, putting the note where you did makes the bullet point look out of place compared to the other bullet points with notes. Please see the rendered version here.
Would it be possible for you to place the note at the bottom of the bullet point content? Thanks!
|
This is helpful. |
k8s-ci-robot
added
the
lgtm
|
/assign @zhangxiaoyu-zidif @jimangel |
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: jimangel The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
* Updated Start Contributing docs asking to limit changes to one language in each PR. * Moved note about one language per PR to end of step 5.
Closes #15762
Updated step 5 in https://kubernetes.io/docs/contribute/start/#submit-a-pull-request with a note asking to limit changes in each PR to one language.
I was initially going to put the note at the bottom of step 5, but it was easy to miss the note. I think the note will be more noticeable at the beginning of the step, especially since step 5 begins with creating a pull request and this is something they should know before they start creating it.