Skip to content

Commit

Permalink
fix: Clarified should definition
Browse files Browse the repository at this point in the history
  • Loading branch information
jlacivita committed Jul 10, 2024
1 parent 8f129b0 commit 5b54553
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion requirements/specifications/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,14 @@ A capability with the level set to `"should"` **SHOULD** be supported.
A capability with the level set to `"could"` **COULD** be supported.

#### 3.1.1. Should vs Could
This section is non-normative.
This section is non-normative and does not denote any requiements.

"Should" means that not supporting a capability has a detremental impact on a Firebolt platform, and care should be taken when deciding not to support a `"should"` capability.

For example, a capability supporting HDMI outputs would likely be assigned a level of `"should"`, since most STB devices have HDMI outputs, while most TV devices do not.

If a capability has a level of `"should"` and the device exposes the functionality in question through hardware or software, then it should either be treated as a `"must"` or a really good reason should exist for why it was not implemented.

If a device has HDMI output ports, then it probably should implement this capability. While a device w/out HDMI output ports does not need to.

"Could" means that this API is truly optional, for example a capability to expose the postal code of the device might be assigned a `level` of `"could"` since Firebolt platforms can justifiably opt not to support this.
Expand Down

0 comments on commit 5b54553

Please sign in to comment.