Conversation
Add release doc with step to release a new gem. Update readme to have badges.
miry
requested review from
a team,
chopify,
djlebersilvestre and
tinchi
and removed request for
a team
| ``` | ||
| gem install toxiproxy | ||
| ```shell | ||
| $ gem install toxiproxy |
There was a problem hiding this comment.
Super minor, but I am not a fan of including $ in command output unless we need to distinguish between typed commands and output being presented to the user.
Advantage of not including the $ is that it makes it easier for people to copy pasta the actual command they need (there's a handy "copy this text" button on Github Markdown boxes) without having to manually remove the preceding $.
There was a problem hiding this comment.
is that it makes it easier for people to copy pasta
that exactly the reason why I am adding $. to force people to think before copy paste. It has extra visability - show that it is command line.
There was a problem hiding this comment.
ideally github should add it automatically for shell code lines. and have empty lines as separation, but it is not supported for now.
There was a problem hiding this comment.
Ok. Aleem on my side :P
muz
left a comment
muz
left a comment
There was a problem hiding this comment.
LGTM - and I'm willing to concede on my minor nit because it's precisely that. Minor.
2 participants
Add release doc with step to release a new gem.
Update readme to have badges.