From b80e1e4a430dd84578d1b1e502aea47996c3549a Mon Sep 17 00:00:00 2001 From: Pete Davison Date: Sat, 29 Oct 2022 16:04:23 +0000 Subject: [PATCH] chore: add schema info to contribution guide --- docs/docs/contributing.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/docs/contributing.md b/docs/docs/contributing.md index 1101ab0ba0..db9c970802 100644 --- a/docs/docs/contributing.md +++ b/docs/docs/contributing.md @@ -60,8 +60,10 @@ to add a new section. If you're updating an existing feature, ensure that the documentation and any examples are up-to-date. Ensure that any examples follow the [Taskfile Styleguide](./styleguide.md). -If you added a new command/flag, ensure that you add it to the [API -Reference](./api_reference.md). +If you added a new field, command or flag, ensure that you add it to the [API +Reference](./api_reference.md). New fields also need to be added to the +[JSON Schema](../static/schema.json). The descriptions for fields in the API +reference and the schema should match. ### Writing tests