docker / app

Make your Docker Compose applications reusable, and share them on Docker Hub
Apache License 2.0
1.57k stars 176 forks source link

Consistent object naming in usage command and examples #704

Closed carolinebriaud closed 4 years ago

carolinebriaud commented 4 years ago

Signed-off-by: Caroline Briaud caroline.briaud@docker.com

- What I did Correct help messages, examples and flag descriptions to match the app naming rules

- How to verify it Go through help, examples and flag description for each docker app command

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

codecov[bot] commented 4 years ago

Codecov Report

Merging #704 into master will decrease coverage by 1.01%. The diff coverage is 95.52%.

Impacted file tree graph

@@            Coverage Diff            @@
##           master    #704      +/-   ##
=========================================
- Coverage   72.21%   71.2%   -1.02%     
=========================================
  Files          59      59              
  Lines        3146    2997     -149     
=========================================
- Hits         2272    2134     -138     
  Misses        580     580              
+ Partials      294     283      -11
Impacted Files Coverage Δ
internal/commands/pull.go 69.23% <100%> (ø) :arrow_up:
internal/commands/init.go 86.66% <100%> (ø) :arrow_up:
internal/commands/image/inspect.go 74.46% <100%> (-4.48%) :arrow_down:
internal/commands/render.go 70.9% <100%> (ø) :arrow_up:
internal/commands/image/tag.go 88.88% <100%> (-2.61%) :arrow_down:
internal/commands/image/list.go 83.33% <100%> (-4.17%) :arrow_down:
internal/commands/remove.go 52% <100%> (ø) :arrow_up:
internal/commands/image/rm.go 62.5% <100%> (-1.61%) :arrow_down:
internal/commands/list.go 84.12% <100%> (ø) :arrow_up:
internal/commands/root.go 75% <100%> (ø) :arrow_up:
... and 13 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update e5b6e29...b07e744. Read the comment docs.

GordonTheTurtle commented 4 years ago

Please sign your commits following these rules: https://github.com/moby/moby/blob/master/CONTRIBUTING.md#sign-your-work The easiest way to do this is to amend the last commit:

$ git clone -b "fix-usages-examples" git@github.com:carolinebriaud/app.git somewhere
$ cd somewhere
$ git rebase -i HEAD~842354382296
editor opens
change each 'pick' to 'edit'
save the file and quit
$ git commit --amend -s --no-edit
$ git rebase --continue # and repeat the amend for each commit
$ git push -f

Amending updates the existing PR. You DO NOT need to open a new one.

silvin-lubecki commented 4 years ago

@carolinebriaud can you rebase this PR?