Skip to content

Commit a673e84

Browse files
authored
chore(github-templates): update docs_report template, update template descriptions (vercel#65178)
## Why? - Update **Docs Request for an Update or Improvement** to **Docs Report**, similar to **Bug Report** - Update template descriptions Closes NEXT-3255
1 parent eb89e39 commit a673e84

File tree

5 files changed

+35
-35
lines changed

5 files changed

+35
-35
lines changed

.github/ISSUE_TEMPLATE/1.bug_report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: Bug Report
2-
description: Create a bug report for the Next.js core
2+
description: Create a bug report for Next.js.
33
labels: ['bug']
44
body:
55
- type: markdown

.github/ISSUE_TEMPLATE/2.example_bug_report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: Bug Report for Examples
2-
description: Create a bug report for one of the Next.js examples
2+
description: Create a bug report for Next.js examples.
33
labels: ['examples']
44
body:
55
- type: markdown
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: 'Docs Report'
2+
description: Create a report for Next.js documentation.
3+
title: 'Docs: '
4+
labels:
5+
- 'Documentation'
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: Before opening a new docs issue, is this something you can help us with? Your contributions are welcomed and appreciated. See our [Docs Contribution Guide](https://nextjs.org/docs/community/contribution-guide) to learn how to edit the Next.js docs.
10+
- type: markdown
11+
attributes:
12+
value: Thank you for helping us update our docs!
13+
- type: textarea
14+
attributes:
15+
label: What is the update you wish to see?
16+
description: 'Example: I would like to fix an example using the `<Link>` component. Or, the `<Link>` component docs are missing information.'
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: Is there any context that might help us understand?
22+
description: A clear description of any added context that might help us understand.
23+
validations:
24+
required: true
25+
- type: input
26+
attributes:
27+
label: Does the docs page already exist? Please link to it.
28+
description: 'Example: https://nextjs.org/docs/app/api-reference/components/link'
29+
validations:
30+
required: false

.github/ISSUE_TEMPLATE/4.docs_request.yml

Lines changed: 0 additions & 30 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ blank_issues_enabled: false
22
contact_links:
33
- name: Ask a question
44
url: https://github.com/vercel/next.js/discussions
5-
about: Ask questions and discuss with other community members
5+
about: Ask questions and discuss with other community members.
66
- name: Feature request
77
url: https://github.com/vercel/next.js/discussions/new?category=ideas
8-
about: Feature requests should be opened as discussions
8+
about: Feature or docs requests should be opened as discussions.
99
- name: Next.js Learn course
1010
url: https://github.com/vercel/next-learn/issues/new
11-
about: Next.js Lean course-related issues should be reported in their respective repository
11+
about: Next.js Learn course-related issues should be reported in their respective repository.

0 commit comments

Comments
 (0)