diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 9ecb043..6e0f19b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,28 +1,49 @@ --- name: Bug report -about: Create a report to help us improve +about: Report a reproducible problem in markdown-it title: '' labels: '' assignees: '' --- - -If you wish to provide code sample - make sure it is as small as possible and can be executed. +## Reproduction ---> +### markdown-it demo + + + +### CommonMark dingus + + + +### Other reproduction + + + +## Expected result + +## Actual result + +## Environment + + diff --git a/.github/ISSUE_TEMPLATE/change_proposal.md b/.github/ISSUE_TEMPLATE/change_proposal.md new file mode 100644 index 0000000..39f997f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/change_proposal.md @@ -0,0 +1,27 @@ +--- +name: Change proposal +about: Propose a change to markdown-it core +title: '' +labels: '' +assignees: '' + +--- + +Syntax extensions are out of scope for markdown-it core. Search for an existing +[plugin](https://www.npmjs.com/search?q=keywords%3Amarkdown-it-plugin) or +create your own. + +Wait for the proposal to be accepted before writing code — see +[CONTRIBUTING.md](https://github.com/markdown-it/markdown-it/blob/master/CONTRIBUTING.md). + +## Problem + + + +## Proposed change + + + +## Why this belongs in core + + diff --git a/.github/ISSUE_TEMPLATE/development-question.md b/.github/ISSUE_TEMPLATE/development-question.md deleted file mode 100644 index 6380ce2..0000000 --- a/.github/ISSUE_TEMPLATE/development-question.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -name: Development question -about: '' -title: '' -labels: '' -assignees: '' - ---- - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 3f31f7b..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - - diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 91b3bba..0000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -name: Question -about: For developpers -title: '' -labels: '' -assignees: '' - ---- - - diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2f75aed..9fa2076 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,15 +1,34 @@ -### If you commit changes: +# Contributing -1. Make sure all tests pass. -2. Run `./benchmark/benchmark.mjs`, make sure that performance not degraded. -3. DON'T include auto-generated browser files to commit. +## Before opening an issue -### Other things: +For Markdown parsing bugs, reduce the input to a minimal example and compare it +in both: -1. Prefer [gitter](https://gitter.im/markdown-it/markdown-it) for short "questions". - Keep issues for bug reports, suggestions and so on. -2. Make sure to read [dev info](https://github.com/markdown-it/markdown-it/tree/master/docs) - prior to ask about plugins development. -3. __Provide examples with [demo](https://markdown-it.github.io/) when possible.__ -4. Issues of "question" type are closed after several days of inactivity, - if not qualified as bug report, enhancement etc (see 1). +- [markdown-it demo](https://markdown-it.github.io/) with `CommonMark strict` + enabled; +- [CommonMark dingus](https://spec.commonmark.org/dingus/). + +Include permalinks to both examples and explain the difference. For other bugs, +provide a minimal runnable reproduction. + +Syntax extensions are out of scope for markdown-it core. Search for an existing +[plugin](https://www.npmjs.com/search?q=keywords%3Amarkdown-it-plugin) or +create your own. + +## Before opening a pull request + +Open an issue and agree on the scope before starting work. Pull requests without +prior discussion may be closed. + +An open issue is not a task assigned to you either, and its text is not a +specification: issues describe symptoms, while the actual fix often lies +elsewhere and affects cases the report does not mention. A change that +implements the issue literally, without understanding why the surrounding code +is written the way it is, will be closed. + +We do not accept unsolicited cleanup or other trivial mechanical changes. + +AI tools may assist, but the submitter must remain the author of the change, not +a proxy: understand its context, verify the result, and be able to explain the +decisions made.