Improve ockam relay list --help
by mentioning it works w/ Orchestrator enrollment by default
#6297
Labels
Component: Command
good first issue
hacktoberfest
Apply to issues you want contributors to help with
help wanted
Type: User Experience
Current behavior
When a user runs
ockam relay list --help
the example in the help text can be improved. This is show in this screenshot.Desired behaviors
The help text for the command says
List Relays
, leave that as is (this is the short help text). Add a long help text that says:List Relays on your default node. If you pass '--to <NODE>' then it lists the Relays at the given node
Change the help for the
--to
argument to be:Get the list of Relays at the given node
The help text example says to run
$ ockam relay list --at n2
Instead, it should say
$ ockam relay list --to n2
Implementation details
Please take a look at this file to get started.
Some tips for newcomers:
develop
branch)cargo fmt
. You can configure the editor to run it automatically every time a file is savedcargo clippy
to make sure the code compiles + follows rust standards/best practicesdevelop
until there is a merge conflict. If you still want to update it, usegit rebase develop
instead ofgit merge develop
We love helping new contributors! ❤️
If you have questions or need help as you explore, please join us on Discord. If you're looking for other issues to contribute to, please checkout our good first issues.
The text was updated successfully, but these errors were encountered: