fix(HTTP): Add contact information to user agent header

stencila · Dec 3, 2020 · d897385 · d897385
1 parent a295205
commit d897385
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/src/util/http.ts b/src/util/http.ts
@@ -18,16 +18,19 @@ const pipeline = util.promisify(stream.pipeline)
 const log = getLogger('encoda:util:http')
 
 /**
- * A `got` instance with default options for
- * HTTP requests.
+ * A `got` instance with default options for HTTP requests.
+ *
+ * User agent is set, and includes a `mailto`, for politeness:
+ * https://github.com/CrossRef/rest-api-doc#good-manners--more-reliable-service
  */
 const http = got.extend({
   cache,
   retry: {
     limit: 5,
   },
   headers: {
-    'user-agent': `Encoda (https://github.com/stencila/encoda)`,
+    'user-agent':
+      'Encoda (https://github.com/stencila/encoda; mailto:[email protected])',
     'accept-encoding': 'gzip, deflate',
   },
 })