From 2cf2b5831a285701bc4714ee23abd93380f9bfb2 Mon Sep 17 00:00:00 2001 From: Luiz Aoqui Date: Tue, 7 Feb 2023 09:46:27 -0500 Subject: [PATCH] docs: update CLI contrib checklist (#16073) --- contributing/checklist-command.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/contributing/checklist-command.md b/contributing/checklist-command.md index 98685cb2f..a3dd39c4a 100644 --- a/contributing/checklist-command.md +++ b/contributing/checklist-command.md @@ -13,11 +13,18 @@ CLI (command/) -> API Client (api/) -> HTTP API (command/agent) -> RPC (nomad/) * [ ] Consider similar commands in Consul, Vault, and other tools. Is there prior art we should match? Arguments, flags, env vars, etc? * [ ] New file in `command/` or in an existing file if a subcommand +* [ ] For nested commands make sure all intermediary subcommands exist (for + example, `nomad acl`, `nomad acl policy`, and `nomad acl policy apply` must + all be valid commands) * [ ] Test new command in `command/` package * [ ] Implement autocomplete * [ ] Implement `-json` (returns raw API response) +* [ ] Implement `-t` (format API response using gotemplate) * [ ] Implement `-verbose` (expands truncated UUIDs, adds other detail) * [ ] Update help text +* [ ] Register new command in `command/commands.go` +* [ ] If the command has a `status` subcommand consider adding a search context + in `nomad/search_endpoint.go` and update `command/status.go` * [ ] Implement and test new HTTP endpoint in `command/agent/_endpoint.go` * [ ] Register new URL paths in `command/agent/http.go` * [ ] Implement and test new RPC endpoint in `nomad/_endpoint.go`