Skip to content

Commit 981c68f

Browse files
authored
organization-specific hooks SHALL use reverse-DNS
Organization-specific hooks SHALL use reverse domain name notation. Fixes #335.
1 parent 28965d7 commit 981c68f

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/hooks/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Hooks are defined in the following format.
9191

9292
### `hook-name-expressed-as-noun-verb`
9393

94-
The name of the hook SHOULD succinctly and clearly describe the activity or event. Hook names are unique so hook creators SHOULD take care to ensure newly proposed hooks do not conflict with an existing hook name. Hook creators MAY choose to name their hook with a URI (e.g. `https://example.org/hooks/patient-transmogrify`) if the hook is specific to an organization.
94+
The name of the hook SHOULD succinctly and clearly describe the activity or event. Hook names are unique so hook creators SHOULD take care to ensure newly proposed hooks do not conflict with an existing hook name. Hook creators SHALL name their hook with reverse domain notation (e.g. `org.example.patient-transmogrify`) if the hook is specific to an organization. Reverse domain notation SHALL not be used by a standard hooks catalog.
9595

9696
When naming hooks, the name should start with the subject (noun) of the hook and be followed by the activity (verb). For example, `patient-view` (not `view-patient`) or `medication-prescribe` (not `prescribe-medication`).
9797

0 commit comments

Comments
 (0)