From 19d01858de0b55f5c013fc96829e6f442affe71e Mon Sep 17 00:00:00 2001 From: Andrew Howe Date: Mon, 17 Apr 2023 22:05:56 +0100 Subject: [PATCH 1/2] Add chain rule commenting guidance --- content/development/contribution_guidelines.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/development/contribution_guidelines.md b/content/development/contribution_guidelines.md index 1c8c82c9..ff7fdfe7 100644 --- a/content/development/contribution_guidelines.md +++ b/content/development/contribution_guidelines.md @@ -38,6 +38,7 @@ chapter: false * No trailing whitespace at EOL. * No trailing blank lines at EOF (only the required single EOF newline character is allowed). * Add comments where possible and clearly explain any new rules. +* Comments must not appear between chained rules and should instead be placed before the start of a rule chain. * Adhere to an 80 character line length limit where possible. * All [chained rules](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual(v2.x)#chain) should be indented like so, for readability: ``` From 2af142ecbf52c400537b1a7bb0347d8c6d66fb72 Mon Sep 17 00:00:00 2001 From: Andrew Howe Date: Mon, 17 Apr 2023 22:09:37 +0100 Subject: [PATCH 2/2] Reorder lines to improve topic flow --- content/development/contribution_guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/development/contribution_guidelines.md b/content/development/contribution_guidelines.md index ff7fdfe7..a4a83f73 100644 --- a/content/development/contribution_guidelines.md +++ b/content/development/contribution_guidelines.md @@ -37,9 +37,9 @@ chapter: false * Files must end with a single newline character. * No trailing whitespace at EOL. * No trailing blank lines at EOF (only the required single EOF newline character is allowed). +* Adhere to an 80 character line length limit where possible. * Add comments where possible and clearly explain any new rules. * Comments must not appear between chained rules and should instead be placed before the start of a rule chain. -* Adhere to an 80 character line length limit where possible. * All [chained rules](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual(v2.x)#chain) should be indented like so, for readability: ``` SecRule .. .. \