Skip to content

Commit

Permalink
Add a section about looking for guidance in other specs. (#542)
Browse files Browse the repository at this point in the history
* Add a section about looking for guidance in other specs.

* Take Martin's rewording.

Co-authored-by: Martin Thomson <[email protected]>

* Add #using-http as guidance from a feature specification.

Co-authored-by: Martin Thomson <[email protected]>

* Add guidance to talk to the relevant community.

---------

Co-authored-by: Martin Thomson <[email protected]>
  • Loading branch information
jyasskin and martinthomson authored Dec 17, 2024
1 parent c63b666 commit f2f2641
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions index.bs
Original file line number Diff line number Diff line change
Expand Up @@ -545,6 +545,32 @@ i.e. consistency within CSS.

There is also a separate section on <a href="#naming-consistency">naming consistency</a>.

<h3 id="specs-include-guidance">Follow guidance from feature specifications</h3>

When using a feature,
follow guidance in the specification for that feature.

Specifications for features
that will be used by other specifications
should include guidance for using those features.
This ensures that the feature is used correctly
and consistently
throughout the platform.

An incomplete list of such guidance follows:

* [[encoding#specification-hooks|Encoding]]
* [[fetch#fetch-elsewhere|Fetch]]
* [[hr-time#sec-tools|Time]]
* [[url#url-apis-elsewhere|URLs]]
* [[#using-http]]

Consult with the relevant community
when using their specification.
This informs that community about new usage
and creates opportunities for improvements
to both the using and used specifications.

<h3 id="feature-detect">New features should be detectable</h3>

Provide a way for authors to programmatically detect
Expand Down

0 comments on commit f2f2641

Please sign in to comment.