Skip to content

Commit c86d242

Browse files
authored
update test descriptions in CONTRIBUTING.md
1 parent 0b7fc5e commit c86d242

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

docs/CONTRIBUTING.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,13 @@ The following table lists the ticket type labels we use when there is work to be
3535

3636
We try to write test cases to validate output (writing tests based on the [supported specifications](#/README.md#specifications)) and minimize regression (writing tests for issues fixed). Therefore, if you would like to contribute, some things you should know regarding the test harness.
3737

38-
|Location |Description |
39-
|:-------------|:---------------------------------------------------|
40-
|/test/browser |For testing Marked in a client-side implementation. |
41-
|/test/new |Tests not related to the original `markdown.pl`. |
42-
|/test/original|Tests validating against the original `markdown.pl`.|
38+
|Location |Description |
39+
|:---------------------|:--------------------------------------------------------------------------------------------------------------|
40+
|/test/specs/commonmark|Tests for [CommonMark](https://spec.commonmark.org/current/) compliance |
41+
|/test/specs/gfm |Tests for [GFM](https://github.github.com/gfm/) compliance |
42+
|/test/specs/new |Tests not related to the original `markdown.pl`. |
43+
|/test/specs/original |Tests validating against the original `markdown.pl`. |
44+
|/test/specs/redos |Tests for [ReDOS](https://www.owasp.org/index.php/Regular_expression_Denial_of_Service_-_ReDoS) vulnerabilities|
4345

4446
If your test uses features or options, assuming `gfm` is set to `false`, for example, you can add [front-matter](https://www.npmjs.com/package/front-matter) to the top of
4547
your `.md` file

0 commit comments

Comments
 (0)