diff --git a/Things-HTTP-Middleware-Developers-Should-Know.md b/Things-HTTP-Middleware-Developers-Should-Know.md index 2629caf..858aebe 100644 --- a/Things-HTTP-Middleware-Developers-Should-Know.md +++ b/Things-HTTP-Middleware-Developers-Should-Know.md @@ -7,4 +7,8 @@ - If you need to wrap or record the response, wrap your own `ResponseWriter` type with `httpserver.ResponseWriterWrapper` so it is guaranteed to implement some crucial interfaces. - The `http.Request.URL` (especially its `.Path` value) may be changed by other "rewriting" middlewares. You can always access the original incoming URL via context: `req.Context().Value(httpserver.OriginalURLCtxKey).(url.URL)` - Directives (and subdirectives) follow `underscore_convention` for naming. Lower-cased, with underscore as word separators. There may be rare exceptions to this (e.g. the `header` directive uses header field names, like `Content-Type` as subdirectives), but usually try to follow this convention. It will make the user's experience with your middleware consistent with the rest of Caddy. Avoid `camelCase` or `hyphen-separation`. -- The first argument to a directive, where applicable, is often the base path to match on a request. \ No newline at end of file +- The first argument to a directive, where applicable, is often the base path to match on a request. + +**For plugin authors in general (TODO: move to separate article when we get enough content):** + +- Plugins _may_ vendor their dependencies _as long as_ they do not export vendored types (i.e. they do not share vendored types with Caddy or with any other plugin). See https://github.com/mattfarina/golang-broken-vendor for why this is bad. \ No newline at end of file