Skip to content

Commit aa3f52a

Browse files
committedApr 11, 2024·
Update CONTRIBUTING.md
1 parent a29b3a1 commit aa3f52a

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed
 

‎CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
Here's what to do whenever adding new rules:
44

55
1. Add your regex to `rules.ini`
6-
2. Add a corresponding test to `tests/types/` with a matching name.
7-
3. Add corresponding lines to `tests/types/_NonMatchingTests.txt` that your test should NOT pick up on. *To reduce merge conflicts, we suggest inserting new strings into random place in the file, instead of at the bottom.*
8-
4. Add a corresponding file in `descriptions` with a matching name describing the technology in a short manner.
6+
2. Add a corresponding test to [`tests/types/`](tests/types) with a matching name.
7+
3. Add corresponding lines to [`tests/types/_NonMatchingTests.txt`](tests/types/_NonMatchingTests.txt) that your test should NOT pick up on. *To reduce merge conflicts, we suggest inserting new strings into random place in the file, instead of at the bottom.*
8+
4. Add a corresponding file in [`descriptions`](descriptions) with a matching name describing the technology in a short manner.
99

1010
**Example:**
1111
Let's say we want to add a rule to detect the FNA game engine. This one is very convenient because it can be matched by simply finding a file named `fna.dll`. However, we also want to be sure to match `some/directory/fna.dll`, but we *don't* want to return a match if we find `some_file_that_just_ends_with_fna.dll` or `fna.dllsomethingelse`.
@@ -24,7 +24,7 @@ Sub/Folder/fna.dll
2424

2525
If the rule is written correctly, it should match both of these filenames.
2626

27-
Then add some lines to `tests/types/_NonmatchingTests.txt` with this content:
27+
Then add some lines to [`tests/types/_NonMatchingTests.txt`](tests/types/_NonMatchingTests.txt) with this content:
2828

2929
```
3030
fna_dll

0 commit comments

Comments
 (0)