Skip to content

Reserve characters in names #7

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Reserve characters in names #7

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
249e571
Reserve characters in names
mkitti Apr 17, 2025
39239bd
Grammar
mkitti Apr 17, 2025
0d8a163
Add section about namespaces, remove `-` as a delim
mkitti Apr 27, 2025
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
30 changes: 29 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,33 @@ The review will be done largely based on avoiding confusing extension names and
Extension maintainers are responsible for their extensions.
Updates to the extensions will also be reviewed by the steering council.

## Name conventions

Registered extensions SHOULD use alphanumeric characters or underscore, `_`.

Registered extensions MUST NOT use reserved characters. The following characters are reserved.

```
reserved = uri-gen-delims / uri-sub-delims / namespace-delims

uri-gen-delims = ":" / "/" / "?" / "#" / "[" / "]" / "@"

uri-sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="

namespace-delims = "." / "~"
```

The reserved characters are a superset of those reserved in [RFC3986].

[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform Resource Identifier (URI): Generic Syntax", STD 66, RFC 3986, DOI 10.17487/RFC3986, January 2005,
https://tools.ietf.org/html/rfc3986.

[RFC3986]:
https://tools.ietf.org/html/rfc3986

## Namespaces

Namespaces MAY precede an extension name or other namespace prefixes. The character `.` MUST be used to delimit namespaces from each other and from the extension names. The primary use of namespaces is to disambiguate extensions with similar names which may differ in implementation or metadata. Extensions SHOULD register without a namespace if there is no amibiguity or difference in implementation from another extension of a similar name or use an existing namespace if applicable.

## Document conventions

Expand All @@ -49,7 +76,8 @@ introduced with the words "for example".
Requirement Levels. March 1997. Best Current Practice. URL:
https://tools.ietf.org/html/rfc2119

[RFC2119]: https://tools.ietf.org/html/rfc2119
[RFC2119]:
https://tools.ietf.org/html/rfc2119

## License

Expand Down