Merge pull request #2395 from nf-core/telatin-punctuation-1

Update modules.md [Clarify modules naming convention ]
nf-core · Mar 25, 2024 · c9639b9 · c9639b9
2 parents a6527c5 + 703c055
commit c9639b9
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/src/content/docs/contributing/modules.md b/src/content/docs/contributing/modules.md
@@ -829,7 +829,7 @@ The key words "MUST", "MUST NOT", "SHOULD", etc. are to be interpreted as descri
 
 ### Naming conventions
 
-1. The directory structure for the module name must be all lowercase e.g. [`modules/nf-core/bwa/mem/`](https://github.com/nf-core/modules/tree/master/modules/nf-core/bwa/mem/). The name of the software (i.e. `bwa`) and tool (i.e. `mem`) MUST be all one word.
+1. The directory structure for the module name must be all lowercase, and without punctuation, e.g. [`modules/nf-core/bwa/mem/`](https://github.com/nf-core/modules/tree/master/modules/nf-core/bwa/mem/). The name of the software (i.e. `bwa`) and tool (i.e. `mem`) MUST be all one word. Note that nf-core/tools will validate your suggested name.
 
 2. The process name in the module file MUST be all uppercase e.g. `process BWA_MEM {`. The name of the software (i.e. `BWA`) and tool (i.e. `MEM`) MUST be all one word separated by an underscore.