Skip to content

Commit

Permalink
Merge pull request #582 from rdcronin/update_api_proposal_with_behavi…
Browse files Browse the repository at this point in the history
…or_section

Expand the API proposal to include a "behavior" section
  • Loading branch information
oliverdunk authored Apr 3, 2024
2 parents 3393381 + 3dd0c89 commit b0a84d4
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions proposals/proposal_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down

0 comments on commit b0a84d4

Please sign in to comment.