Skip to content

Commit 2ac653d

Browse files
Derek Lewisaddaleax
Derek Lewis
authored andcommitted
meta: make issue template mobile friendly and address nits
PR-URL: #34243 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Anto Aravinth <[email protected]>
1 parent eff1feb commit 2ac653d

File tree

1 file changed

+41
-18
lines changed

1 file changed

+41
-18
lines changed

.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md

+41-18
Original file line numberDiff line numberDiff line change
@@ -7,48 +7,71 @@ labels: doc
77

88
# 📗 API Reference Docs Problem
99

10-
<!------------------------------------------------------------------------------
10+
<!--
11+
1112
Thank you for wanting to make nodejs.org better!
1213
13-
This template is for issues with the Node.js API reference docs.
14+
This template is for issues with the Node.js API
15+
reference documentation.
1416
15-
For more general support, please open an issue in
16-
our help repo at “https://github.com/nodejs/help”.
17+
For problems with nodejs.org beyond the API
18+
reference documentation, please open an issue
19+
using the issue tracker for our site repository.
1720
18-
For the issue title, enter a one-line summary after “doc: ”.
19-
The “✍️” signifies a request for input. If unsure, do the best you can.
21+
https://github.com/nodejs/nodejs.org
2022
21-
If you found a problem with nodejs.org beyond the API reference docs, please
22-
open an issue in our website repo at “https://github.com/nodejs/nodejs.org”.
23-
------------------------------------------------------------------------------->
23+
For more general support, please open an issue
24+
using the issue tracker for our help repository.
25+
26+
https://github.com/nodejs/help
27+
28+
---
29+
30+
For the issue title, please enter a one-line
31+
summary after “doc: ” (preferably 50 characters
32+
or less and no more than 72).
33+
34+
The “✍️” are placeholders signifying requests for
35+
input. Replace them with your responses.
36+
37+
If you are unsure of something, do your best.
2438
25-
<!--
26-
Version: output of “node -v”
27-
Platform: output of “uname -a” (UNIX), or version and 32 or 64-bit (Windows)
28-
Subsystem: if known, please specify affected core module name
2939
-->
3040

41+
<!-- The output of “node --version”. -->
42+
3143
- **Version**: ✍️
44+
45+
<!-- The output of “uname -a” (UNIX) or version
46+
and 32-bit or 64-bit (Windows). -->
47+
3248
- **Platform**: ✍️
49+
50+
<!-- The name of affected core module. -->
51+
3352
- **Subsystem**: ✍️
3453

3554
## Location
3655

3756
_Section of the site where the content exists_
3857

3958
Affected URL(s):
59+
4060
- https://nodejs.org/api/✍️
4161

42-
## Problem description
62+
## Description
4363

44-
_Concise explanation of what you found to be problematic_
64+
_Concise explanation of the problem_
4565

46-
<!-- If applicable, include any screenshots that may help solve the problem. -->
66+
<!-- If applicable, include any screenshots that
67+
may help solve the problem. -->
4768

4869
✍️
4970

5071
---
5172

52-
<!-- Use “[x]” to check the box below if interested in contributing. -->
73+
<!-- Use “[x]” to check the box below if you are
74+
interested in contributing. -->
5375

54-
- [ ] I would like to work on this issue and submit a pull request.
76+
- [ ] I would like to work on this issue and
77+
submit a pull request.

0 commit comments

Comments
 (0)