Skip to content
This repository was archived by the owner on May 14, 2020. It is now read-only.

Commit f51843d

Browse files
authored
Merge pull request #1592 from annawinkler/update-contributing-doc
Update name of branch to use for feature branches to v3.3/dev
2 parents bb15dee + 866ffaa commit f51843d

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ please adhere to the following contributing guidelines.
1414

1515
## Making Changes
1616

17-
* Please base your changes on branch ```v3.2/dev```
17+
* Please base your changes on branch ```v3.3/dev```
1818
* Create a topic branch for your feature or bug fix.
1919
* Please fix only one problem at a time; this will help to quickly test and merge your change. If you intend to fix multiple unrelated problems, please use a separate branch for each problem.
2020
* Make commits of logical units.
@@ -36,9 +36,9 @@ please adhere to the following contributing guidelines.
3636
SecRule .. ..\
3737
".."
3838
```
39-
- use quotes even if there is only one action, it improves readability (e.g use `"chain"`, not `chain`, or `"ctl:requestBodyAccess=Off"` instead of `ctl:requestBodyAccess=Off`)
39+
- use quotes even if there is only one action, it improves readability (e.g., use `"chain"`, not `chain`, or `"ctl:requestBodyAccess=Off"` instead of `ctl:requestBodyAccess=Off`)
4040
- always use numbers for phases, instead of names
41-
- format your `SecMarker` between double quotes, using UPPERCASE and separating words using hyphens. Examples are
41+
- format your `SecMarker` between double quotes, using UPPERCASE and separating words using hyphens. Examples are:
4242
```
4343
SecMarker "END-RESPONSE-959-BLOCKING-EVALUATION"
4444
SecMarker "END-REQUEST-910-IP-REPUTATION"
@@ -75,26 +75,26 @@ please adhere to the following contributing guidelines.
7575
skipAfter
7676
```
7777

78-
## Variables naming conventions
78+
## Variable naming conventions
7979

8080
* Variable names are lowercase using chars from `[a-z0-9_]`
8181
* To somewhat reflect the fact that the syntax for variable usage is different when you define it (using setvar) and when you use it, we propose the following visual distinction:
82-
* Lowercase letters for collection, dot as separator, variable name. E.g: `setvar:tx.foo_bar_variable`
83-
* Capital letters for collection, colon as separator, variable name. E.g: `SecRule TX:foo_bar_variable`
82+
* Lowercase letters for collection, dot as separator, variable name. E.g.,: `setvar:tx.foo_bar_variable`
83+
* Capital letters for collection, colon as separator, variable name. E.g.,: `SecRule TX:foo_bar_variable`
8484

8585
## Rules compliance with each Paranoia Level (PL)
8686

8787
Rules in the CRS are organized in Paranoia Levels, which allows you to choose the desired level of rule checks.
8888

89-
Please read file ```crs-setup.conf.example``` for introduction and a more detailed explanation of Paranoia Levels in the section `# -- [[ Paranoia Level Initialization ]]`.
89+
Please read file ```crs-setup.conf.example``` for an introduction and a more detailed explanation of Paranoia Levels in the section `# -- [[ Paranoia Level Initialization ]]`.
9090

9191
**PL0:**
9292

9393
* Modsec installed, but almost no rules
9494

9595
**PL1:**
9696

97-
* Default level, keep in mind that most installations will normally use this one.
97+
* Default level, keep in mind that most installations will normally use this one
9898
* If there is a complex memory consuming/evaluation rule it surely will be on upper levels, not this one
9999
* Normally we will use atomic checks in single rules
100100
* Confirmed matches only, all scores are allowed
@@ -146,8 +146,8 @@ Among the rules serving a CRS helper functionality are rules that skip rules dep
146146

147147
The blocking or filter rules start with 9XX100 with a step width of 10. E.g. 9XX100, 9XX110, 9XX120 etc. The rule id does not correspond directly with the paranoia level of a rule. Given the size of a rule group and the organization by lower PL rules first, PL2 and above tend to have rule IDs with higher numbers.
148148

149-
Within a rule file / block, there are sometimes smaller groups of rules that belong to together. They are closely linked and very often represent copies of the original rules with a stricter limit (alternatively, they can represent the same rule addressing a different target in a second rule where this was necessary). These are stricter siblings of the base rule. Stricter siblings usually share the first five digits of the rule ID and raise the rule ID by one. E.g. Base rule at 9XX160, stricter sibling at 9XX161.
149+
Within a rule file / block, there are sometimes smaller groups of rules that belong to together. They are closely linked and very often represent copies of the original rules with a stricter limit (alternatively, they can represent the same rule addressing a different target in a second rule where this was necessary). These are stricter siblings of the base rule. Stricter siblings usually share the first five digits of the rule ID and raise the rule ID by one. E.g., Base rule at 9XX160, stricter sibling at 9XX161.
150150

151-
Stricter siblings often have a different paranoia level. This means that the base rule and the stricter sibling do not reside next to one another in the rule file. Instead they are ordered in their appropriate paranoia level and can be linked via the first digits of the rule id. It is a good practice to introduce stricter siblings together with the base rule in the comments of the base rule and to reference the base rule with the keyword stricter sibling in the comments of the stricter sibling. E.g. "... This is
151+
Stricter siblings often have a different paranoia level. This means that the base rule and the stricter sibling do not reside next to one another in the rule file. Instead they are ordered in their appropriate paranoia level and can be linked via the first digits of the rule id. It is a good practice to introduce stricter siblings together with the base rule in the comments of the base rule and to reference the base rule with the keyword stricter sibling in the comments of the stricter sibling. E.g., "... This is
152152
performed in two separate stricter siblings of this rule: 9XXXX1 and 9XXXX2", "This is a stricter sibling of rule 9XXXX0."
153153

0 commit comments

Comments
 (0)