diff --git a/contributing/checklist-command.md b/contributing/checklist-command.md index 9a5448835..6473c4894 100644 --- a/contributing/checklist-command.md +++ b/contributing/checklist-command.md @@ -10,23 +10,23 @@ CLI (command/) -> API Client (api/) -> HTTP API (command/agent) -> RPC (nomad/) ## Code -1. [ ] New file in `command/` or in an existing file if a subcommand -2. [ ] Test new command in `command/` package -3. [ ] Implement autocomplete -4. [ ] Implement `-json` (returns raw API response) -5. [ ] Implement `-verbose` (expands truncated UUIDs, adds other detail) -7. [ ] Update help text -7. [ ] Implement and test new HTTP endpoint in `command/agent/_endpoint.go` -8. [ ] Implement and test new RPC endpoint in `nomad/_endpoint.go` -9. [ ] Implement and test new Client RPC endpoint in +* [ ] 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) -10. [ ] Implement and test new `api/` package Request and Response structs -11. [ ] Implement and test new `api/` package helper methods -12. [ ] Implement and test new `nomad/structs/` package Request and Response structs +* [ ] 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 ## Docs -1. [ ] Changelog -2. [ ] API docs https://www.nomadproject.io/api/index.html -3. [ ] CLI docs https://www.nomadproject.io/docs/commands/index.html -4. [ ] Consider if it needs a guide https://www.nomadproject.io/guides/index.html +* [ ] Changelog +* [ ] API docs https://www.nomadproject.io/api/index.html +* [ ] CLI docs https://www.nomadproject.io/docs/commands/index.html +* [ ] Consider if it needs a guide https://www.nomadproject.io/guides/index.html diff --git a/contributing/checklist-jobspec.md b/contributing/checklist-jobspec.md index aad500bf0..195cb0cb6 100644 --- a/contributing/checklist-jobspec.md +++ b/contributing/checklist-jobspec.md @@ -2,24 +2,24 @@ ## Code -1. [ ] Parse in `jobspec/parse.go` -2. [ ] Test in `jobspec/parse_test.go` (preferably with a +* [ ] Parse in `jobspec/parse.go` +* [ ] Test in `jobspec/parse_test.go` (preferably with a `jobspec/text-fixtures/.hcl` test file) -3. [ ] Add structs/fields to `api/` package +* [ ] Add structs/fields to `api/` package * structs usually have Canonicalize, Copy, and Merge methods * New fields should be added to existing Canonicalize, Copy, and Merge methods * Test the struct/field via all methods mentioned above -4. [ ] Add structs/fields to `nomad/structs` package +* [ ] Add structs/fields to `nomad/structs` package * Validation happens in this package and must be implemented * Implement other methods and tests from `api/` package -5. [ ] Add conversion between `api/` and `nomad/structs` in `command/agent/job_endpoint.go` -6. [ ] Test conversion +* [ ] Add conversion between `api/` and `nomad/structs` in `command/agent/job_endpoint.go` +* [ ] Test conversion ## Docs -1. [ ] Changelog -2. [ ] Jobspec entry https://www.nomadproject.io/docs/job-specification/index.html -3. [ ] Job JSON API entry https://www.nomadproject.io/api/json-jobs.html -4. [ ] Sample Response output in API https://www.nomadproject.io/api/jobs.html -5. [ ] Consider if it needs a guide https://www.nomadproject.io/guides/index.html +* [ ] Changelog +* [ ] Jobspec entry https://www.nomadproject.io/docs/job-specification/index.html +* [ ] Job JSON API entry https://www.nomadproject.io/api/json-jobs.html +* [ ] Sample Response output in API https://www.nomadproject.io/api/jobs.html +* [ ] Consider if it needs a guide https://www.nomadproject.io/guides/index.html