From aa17c26399c4ed0ceca85b734db43bf823bae0dd Mon Sep 17 00:00:00 2001 From: Neal Gompa Date: Apr 19 2023 19:23:57 +0000 Subject: guidelines/Naming: Add information about NGINX module packages It has been possible to package NGINX modules for a few cycles now and a few packages exist in the distribution. This documents the pattern being used there. --- diff --git a/guidelines/modules/ROOT/pages/Naming.adoc b/guidelines/modules/ROOT/pages/Naming.adoc index 1fce4b6..a7409cd 100644 --- a/guidelines/modules/ROOT/pages/Naming.adoc +++ b/guidelines/modules/ROOT/pages/Naming.adoc @@ -381,6 +381,16 @@ Some examples: |============================================= +=== NGINX modules + +Packages of NGINX modules SHOULD begin +with the prefix `+nginx-mod-+`. +In particular, this prefix SHOULD NOT be pluralized +(i.e., it SHOULD NOT be `+nginx-mods+`). +Some upstream projects may use `+module+` as a +prefix, and this should be accounted for and +replaced accordingly in the package name. + === OCaml modules OCaml modules, libraries and syntax extensions