diff options
Diffstat (limited to 'packages/markdown/marked/docs/CONTRIBUTING.md')
| -rw-r--r-- | packages/markdown/marked/docs/CONTRIBUTING.md | 23 |
1 files changed, 13 insertions, 10 deletions
diff --git a/packages/markdown/marked/docs/CONTRIBUTING.md b/packages/markdown/marked/docs/CONTRIBUTING.md index ac88ba15..f5ec82b6 100644 --- a/packages/markdown/marked/docs/CONTRIBUTING.md +++ b/packages/markdown/marked/docs/CONTRIBUTING.md @@ -5,9 +5,10 @@ - [ ] Make sure you are on the `master` branch. - [ ] Be sure to run `npm install` or `npm update`. - [ ] Create a branch. -- [ ] Make as small a change as possible. -- [ ] Run `npm test`, fix any broken things (for linting, you can run `npm run lint` to have the linter fix them for you). -- [ ] Submit a PR. +- [ ] Update code in `src` folder. (`lib` folder is for auto compiled code) +- [ ] Run `npm run test:all`, fix any broken things (for linting, you can run `npm run lint` to have the linter fix them for you). +- [ ] Run `npm run build:reset` to remove changes to compiled files. +- [ ] Submit a Pull Request. ## Design principles @@ -30,16 +31,19 @@ The following table lists the ticket type labels we use when there is work to be |RR - refactor and re-engineer |Results in an improvement to developers using Marked (improved readability) or end-users (faster performance) or both. | |NFS - new feature (spec related) |A capability Marked does not currently provide but is in one of the [supported specifications](#/README.md#specifications) | |NFU - new feature (user requested) |A capability Marked does not currently provide but has been requested by users of Marked. | +|NFE - new feature (should be an extension) |A capability Marked does not currently provide and is not part of a spec. | ## Test early, often, and everything 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. -|Location |Description | -|:-------------|:---------------------------------------------------| -|/test/browser |For testing Marked in a client-side implementation. | -|/test/new |Tests not related to the original `markdown.pl`. | -|/test/original|Tests validating against the original `markdown.pl`.| +|Location |Description | +|:---------------------|:--------------------------------------------------------------------------------------------------------------| +|/test/specs/commonmark|Tests for [CommonMark](https://spec.commonmark.org/current/) compliance | +|/test/specs/gfm |Tests for [GFM](https://github.github.com/gfm/) compliance | +|/test/specs/new |Tests not related to the original `markdown.pl`. | +|/test/specs/original |Tests validating against the original `markdown.pl`. | +|/test/specs/redos |Tests for [ReDOS](https://www.owasp.org/index.php/Regular_expression_Denial_of_Service_-_ReDoS) vulnerabilities| 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 your `.md` file @@ -84,9 +88,8 @@ To check for (and fix) standardized syntax (lint): npm run lint ``` -To build your own minified version of Marked: +To build your own es5, esm, and minified versions of Marked: ```bash npm run build ``` - |