summaryrefslogtreecommitdiffstats
path: root/packages/markdown/marked/.github/PULL_REQUEST_TEMPLATE.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/markdown/marked/.github/PULL_REQUEST_TEMPLATE.md')
-rw-r--r--packages/markdown/marked/.github/PULL_REQUEST_TEMPLATE.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/packages/markdown/marked/.github/PULL_REQUEST_TEMPLATE.md b/packages/markdown/marked/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..8274e607
--- /dev/null
+++ b/packages/markdown/marked/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,53 @@
+
+<!--
+
+ If release PR, add ?template=release.md to the PR url to use the release PR template.
+
+ If badging PR, add ?template=badges.md to the PR url to use the badges PR template.
+
+ Otherwise, you are stating this PR fixes an issue that has been submitted; or,
+ describes the issue or proposal under consideration and contains the project-related code to implement.
+
+-->
+
+**Marked version:**
+
+<!-- The NPM version or commit hash having the issue -->
+
+**Markdown flavor:** Markdown.pl|CommonMark|GitHub Flavored Markdown|n/a
+
+## Description
+
+- Fixes #### (if fixing a known issue; otherwise, describe issue using the following format)
+
+<!--
+
+ If no issue exists that you're aware of. The maintainers should be able to figure out if it's a duplicate.
+
+## Expectation
+
+Describe the output you are expecting from marked
+
+## Result
+
+Describe the output you received from marked
+
+## What was attempted
+
+Describe what code combination got you there
+
+-->
+
+## Contributor
+
+- [ ] Test(s) exist to ensure functionality and minimize regression (if no tests added, list tests covering this PR); or,
+- [ ] no tests required for this PR.
+- [ ] If submitting new feature, it has been documented in the appropriate places.
+
+## Committer
+
+In most cases, this should be a different person than the contributor.
+
+- [ ] Draft GitHub release notes have been updated.
+- [ ] CI is green (no forced merge required).
+- [ ] Merge PR