diff --git a/contributing/checklist-command.md b/contributing/checklist-command.md index 6473c4894..399767616 100644 --- a/contributing/checklist-command.md +++ b/contributing/checklist-command.md @@ -10,16 +10,18 @@ CLI (command/) -> API Client (api/) -> HTTP API (command/agent) -> RPC (nomad/) ## Code -* [ ] New file in `command/` or in an existing file if a subcommand -* [ ] Test new command in `command/` package -* [ ] Implement autocomplete -* [ ] Implement `-json` (returns raw API response) -* [ ] Implement `-verbose` (expands truncated UUIDs, adds other detail) -* [ ] Update help text -* [ ] Implement and test new HTTP endpoint in `command/agent/_endpoint.go` -* [ ] Implement and test new RPC endpoint in `nomad/_endpoint.go` -* [ ] Implement and test new Client RPC endpoint in - `client/_endpoint.go` (For client endpoints like Filesystem only) +* [ ] 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 +* [ ] Test new command in `command/` package +* [ ] Implement autocomplete +* [ ] Implement `-json` (returns raw API response) +* [ ] Implement `-verbose` (expands truncated UUIDs, adds other detail) +* [ ] Update help text +* [ ] Implement and test new HTTP endpoint in `command/agent/_endpoint.go` +* [ ] Implement and test new RPC endpoint in `nomad/_endpoint.go` +* [ ] Implement and test new Client RPC endpoint in + `client/_endpoint.go` (For client endpoints like Filesystem only) * [ ] Implement and test new `api/` package Request and Response structs * [ ] Implement and test new `api/` package helper methods * [ ] Implement and test new `nomad/structs/` package Request and Response structs diff --git a/contributing/checklist-jobspec.md b/contributing/checklist-jobspec.md index 19e33521c..bfea056c5 100644 --- a/contributing/checklist-jobspec.md +++ b/contributing/checklist-jobspec.md @@ -2,6 +2,8 @@ ## Code +* [ ] Consider similar features in Consul, Kubernetes, and other tools. Is + there prior art we should match? Terminology, structure, etc? * [ ] Parse in `jobspec/parse.go` * [ ] Test in `jobspec/parse_test.go` (preferably with a `jobspec/text-fixtures/.hcl` test file)