Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a section about looking for guidance in other specs. #542

Merged
merged 4 commits into from
Dec 17, 2024
Merged

Add a section about looking for guidance in other specs. #542

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
779818c
Add a section about looking for guidance in other specs.
jyasskin Dec 13, 2024
a93ba72
Take Martin's rewording.
jyasskin Dec 13, 2024
0d47b9d
Add #using-http as guidance from a feature specification.
jyasskin Dec 17, 2024
f980d22
Add guidance to talk to the relevant community.
jyasskin Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -544,6 +544,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.

jyasskin marked this conversation as resolved.
Show resolved Hide resolved
martinthomson marked this conversation as resolved.
Show resolved Hide resolved
<h3 id="feature-detect">New features should be detectable</h3>

Provide a way for authors to programmatically detect
Expand Down
Loading