summaryrefslogtreecommitdiff
path: root/docs/contributing
diff options
context:
space:
mode:
authorNayeem Rahman <nayeemrmn99@gmail.com>2020-05-25 18:32:34 +0100
committerGitHub <noreply@github.com>2020-05-25 13:32:34 -0400
commit4ebd24342368adbb99582b87dc6c4b8cb6f44c87 (patch)
tree0e98b22c00497d48ea901bc24bad8fe182fdd056 /docs/contributing
parent08f74e1f6a180e83e13f5570811b8b7fcec90e9f (diff)
fix(std/testing/asserts): Support browsers (#5847)
Diffstat (limited to 'docs/contributing')
-rw-r--r--docs/contributing/style_guide.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/contributing/style_guide.md b/docs/contributing/style_guide.md
index ed23f31e1..0bd7c628f 100644
--- a/docs/contributing/style_guide.md
+++ b/docs/contributing/style_guide.md
@@ -314,3 +314,16 @@ export function foo(): string {
`https://deno.land/std/` is intended to be baseline functionality that all Deno
programs can rely on. We want to guarantee to users that this code does not
include potentially unreviewed third party code.
+
+#### Document and maintain browser compatiblity.
+
+If a module is browser compatible, include the following in the JSDoc at the top
+of the module:
+
+```ts
+/** This module is browser compatible. */
+```
+
+Maintain browser compatibility for such a module by either not using the global
+`Deno` namespace or feature-testing for it. Make sure any new dependencies are
+also browser compatible.