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

Improve ockam relay list --help by mentioning it works w/ Orchestrator enrollment by default #6297

Closed
nazmulidris opened this issue Oct 4, 2023 · 2 comments · Fixed by #6356
Assignees

Comments

@nazmulidris
Copy link
Contributor

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.

Image

Desired behaviors

  1. 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

  2. Change the help for the --to argument to be: Get the list of Relays at the given node

  3. The help text example says to run $ ockam relay list --at n2
    Instead, it should say $ ockam relay list --to n2

Implementation details

Here's an example of using the long_about attribute in another file:

#[derive(Clone, Debug, Args)]
#[command(
long_about = docs::about(LONG_ABOUT),

Please take a look at this file to get started.


Some tips for newcomers:

  1. Create a new branch for the issue you are working on (don't push directly to your fork's develop branch)
  2. In the PR description, include the issue that's being solved
  3. Run cargo fmt. You can configure the editor to run it automatically every time a file is saved
  4. Run cargo clippy to make sure the code compiles + follows rust standards/best practices
  5. You don't need to keep your branch updated with develop until there is a merge conflict. If you still want to update it, use git rebase develop instead of git 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.

@0scvr
Copy link
Contributor

0scvr commented Oct 6, 2023

I'll work on this if still up for grabs 😊

@nazmulidris
Copy link
Contributor Author

@0scvr That's awesome, this is all yours. Please let us know if you have any questions as you explore. You can also ask questions on the contributors discord https://discord.gg/RAbjRr3kds

Also, please associate your PR and issue using this technique: https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants