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

scripts: remove the markdown_you_pass #16709

Merged
merged 1 commit into from
Oct 8, 2023

Conversation

fuweid
Copy link
Member

@fuweid fuweid commented Oct 8, 2023

Part of #15549

The markdown_you_pass was introduced by #7416

But in the etcd-io org, I don't see any documents relative to eschew-you.

The comment like Get your pull request reviewed seems reasonable.
This pr is to clean up the markdown_you_pass.

Please read https://github.com/etcd-io/etcd/blob/main/CONTRIBUTING.md#contribution-flow.

Signed-off-by: Wei Fu <fuweid89@gmail.com>
Copy link
Member

@jmhbnz jmhbnz left a comment

Choose a reason for hiding this comment

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

LGTM - Happy to remove this. Personally I prefer more active voice documentation to make it clear where the reader needs to do something.

The kubernetes documentation style guide now also explicitly encourages using words like "you" to show active voice and address the reader:

@fuweid
Copy link
Member Author

fuweid commented Oct 8, 2023

The kubernetes documentation style guide now also explicitly encourages using words like "you" to show active voice: https://kubernetes.io/docs/contribute/style/style-guide/#use-active-voice

Nice reference! Thanks

Copy link
Member

@ahrtr ahrtr left a comment

Choose a reason for hiding this comment

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

LGTM

thx for the cleanup.

@serathius serathius merged commit 01a0d8b into etcd-io:main Oct 8, 2023
27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants