From 3dd0c893070e149725ba523a0242916d5bd4c157 Mon Sep 17 00:00:00 2001 From: Devlin Cronin Date: Mon, 1 Apr 2024 14:51:33 -0700 Subject: [PATCH] Expand the API proposal to include a "behavior" section The behavior of certain APIs may not be immediately clear from the API schema. Add a separate section for "behavior" to allow authors to specify notes related to the behavior of the API if they are non- obvious. --- proposals/proposal_template.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/proposals/proposal_template.md b/proposals/proposal_template.md index b69216de..f045a41c 100644 --- a/proposals/proposal_template.md +++ b/proposals/proposal_template.md @@ -67,6 +67,22 @@ A few notes: additional optional properties. Even if you currently only accept one property, it often makes sense to wrap this in an object. +### Behavior + +Describe the behavior of the new API if there is anything that is not +immediately obvious from the schema above. Include descriptions of: + +* Behavior on the newly-introduced types and methods. +* Impacted behavior on existing API methods and surfaces, if any. + +This does not (yet) need to follow strict spec language; however, the more clear +you can be the better. This helps reduce the number of questions that may arise +during the API review as well as ensure browsers are able to align with one +another. + +You may add subsections (e.g., `#### Behavior Section 1` and +`#### Behavior Section 2`) as appropriate to aid in readbility. + ### New Permissions | Permission Added | Suggested Warning |