Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 Replace ⚠️ with ⚠️ in Contributing Guidelines documentation #6550

Merged
merged 2 commits into from
May 27, 2022

Conversation

oscr
Copy link
Contributor

@oscr oscr commented May 25, 2022

What this PR does / why we need it:

Looks like :warning: isn't rendered in the Contributing Guidelines document (as shown below) so I suggest replacing it with the ⚠️ emoji. As a small side note: the commit message and diff preview look a little odd since Github seems to always render :warning: as ⚠️.

Screenshot from 2022-05-25 23-09-33

https://cluster-api.sigs.k8s.io/contributing#codebase-and-go-modules

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 25, 2022
@k8s-ci-robot
Copy link
Contributor

Hi @oscr. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label May 25, 2022
Copy link
Contributor

@killianmuldoon killianmuldoon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch - the base issue here is that this is a dual use document.

We expect users to read it on github (where the warning is rendered correctly) and where it's mirrored in the book (and not rendered correctly).

I don't think it's a big issue - but there are a couple of other instances we could change. @oscr do you mind updating the other occurrences with the emoji instead of the tag?:

## :warning: Go Module changes :warning:

## :warning: LeaderElectionResourceLock change :warning:

@killianmuldoon
Copy link
Contributor

/lgtm

Awesome - thank you!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 26, 2022
@oscr
Copy link
Contributor Author

oscr commented May 26, 2022

I don't think it's a big issue - but there are a couple of other instances we could change. @oscr do you mind updating the other occurrences with the emoji instead of the tag?:

Great catch! Thanks @killianmuldoon. I've fixed both.

@sbueringer
Copy link
Member

Thx!

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbueringer

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 27, 2022
@k8s-ci-robot k8s-ci-robot merged commit 823cbf0 into kubernetes-sigs:main May 27, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.2 milestone May 27, 2022
@oscr oscr deleted the fix-documentation-formatting branch June 17, 2022 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants