docker / cli

The Docker CLI
Apache License 2.0
4.77k stars 1.89k forks source link

#770 - Removed all mentions of "please" from docs and messages #5040

Closed ggracechoi closed 1 month ago

ggracechoi commented 3 months ago

- What I did We removed all references to the word "please" throughout the entire repository.

- How I did it We used the search feature to look for all mentions of "please" and removed them. We also capitalized the following word if the "please" was the first word in the sentence.

- How to verify it Use the search feature to look for instances of "please" in the code base.

- Description for the changelog

All mentions of the word "please" were removed from the docs and messages in this repository.

- A picture of a cute animal (not mandatory but encouraged) tiger

vvoland commented 2 months ago

What's wrong with having "please"?

thaJeztah commented 2 months ago

@vvoland I think this PR is to address;

There's various articles on this, but here's a nice one that outlines some reasoning; https://medium.com/@xupeilan05/why-please-has-no-place-in-ux-writing-tips-for-clear-and-assertive-copy-bd096b7f976a

thaJeztah commented 2 months ago

Thank you for contributing! It appears your commit message is missing a DCO sign-off, causing the DCO check to fail.

We require all commit messages to have a Signed-off-by line with your name and e-mail (see "Sign your work" in the CONTRIBUTING.md in this repository), which looks something like:

Signed-off-by: YourFirsName YourLastName <yourname@example.org>

There is no need to open a new pull request, but to fix this (and make CI pass), you need to amend the commit(s) in this pull request, and "force push" the amended commit.

Unfortunately, it's not possible to do so through GitHub's web UI, so this needs to be done through the git commandline.

You can find some instructions in the output of the DCO check (which can be found in the "checks" tab on this pull request), as well as in the Moby contributing guide.

Steps to do so "roughly" come down to:

  1. Set your name and e-mail in git's configuration:

    git config --global user.name "YourFirstName YourLastName"
    git config --global user.email "yourname@example.org"

    (Make sure to use your real name (not your GitHub username/handle) and e-mail)

  2. Clone your fork locally

  3. Check out the branch associated with this pull request

  4. Sign-off and amend the existing commit(s)

    git commit --amend --no-edit --signoff

    If your pull request contains multiple commits, either squash the commits (if needed) or sign-off each individual commit.

  5. Force push your branch to GitHub (using the --force or --force-with-lease flags) to update the pull request.

Sorry for the hassle (I wish GitHub would make this a bit easier to do), and let me know if you need help or more detailed instructions!

thaJeztah commented 2 months ago

OH! I think the DCO may be the DCO check being too restrictive;

Commit sha: a0df7b9, Author: Grace Choi, Committer: Grace Choi; Can not find "Grace Choi grace.54109@gmail.com", in ["Grace Choi gracechoi@utexas.edu", "Pranjal Rai pranjalrai@utexas.edu"].

It's probably fine to mark that as "ok" manually; let me do so.

codecov-commenter commented 2 months ago

Codecov Report

Attention: Patch coverage is 45.45455% with 6 lines in your changes are missing coverage. Please review.

Project coverage is 61.08%. Comparing base (7f15dfa) to head (a0df7b9). Report is 27 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #5040 +/- ## ========================================== - Coverage 61.08% 61.08% -0.01% ========================================== Files 295 298 +3 Lines 20660 20672 +12 ========================================== + Hits 12621 12628 +7 - Misses 7142 7147 +5 Partials 897 897 ```
thaJeztah commented 1 month ago