From 7d7d92778ec79631d847e8fef0b86b664ca29f73 Mon Sep 17 00:00:00 2001 From: Derek Lewis Date: Wed, 29 Apr 2020 03:29:49 -0400 Subject: [PATCH] fixup! meta: add issue template for API reference docs --- .../ISSUE_TEMPLATE/3-api-ref-docs-problem.md | 44 +++++++++---------- 1 file changed, 21 insertions(+), 23 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md b/.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md index d33ed1598a6620..a20643447df209 100644 --- a/.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md +++ b/.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md @@ -1,5 +1,5 @@ --- -name: "\U0001F4D7 Open an issue regarding the nodejs.org API reference docs" +name: "\U0001F4D7 Open an issue regarding the Node.js API reference docs" about: Let us know about any problematic API reference documents title: "doc: " labels: doc @@ -7,19 +7,22 @@ labels: doc # 📗 API Reference Docs Problem - + - -- [ ] Missing -- [ ] Needed -- [ ] Confusing -- [ ] Didn't work -- [ ] Other () - ## Location -_Section of the site where the content lives (or should)._ +_Section of the site where the content exists (or should)_ Affected URL(s): - - https://nodejs.org/api/✍️ ## Reproduction procedure @@ -55,20 +47,26 @@ _Steps to reproduce the problem_ ## Expected behavior/code -_What you were expecting._ +_What your expectation was_ + +✍️ + +## Actual behavior/code + +_What you found to be problematic_ ✍️ ## Additional information -_Any other information that would be helpful to solve this._ +_Anything else (e.g., screenshots, etc.) that may help solve the problem_ - + ✍️ --- - + - [ ] I would like to work on this issue and submit a pull request.