Skip to content

Commit fb9d967

Browse files
authored
Merge pull request #329 from langgenius/feat/add-issue-template
feat: add issue template
2 parents 364bf2d + 051938b commit fb9d967

1 file changed

Lines changed: 68 additions & 0 deletions

File tree

.github/ISSUE_TEMPLATE/docs.yml

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: Documentation Change Request
2+
description: Suggest changes or improvements to the documentation
3+
title: "[DOCS]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to help us improve our documentation!
10+
11+
- type: dropdown
12+
id: type
13+
attributes:
14+
label: Type of Documentation Change
15+
options:
16+
- Error/Typo fix
17+
- Content update
18+
- New documentation
19+
- Translation
20+
- Reorganization
21+
- Other
22+
validations:
23+
required: true
24+
25+
- type: input
26+
id: page
27+
attributes:
28+
label: Documentation Page URL or Path
29+
description: Please provide the URL or file path of the documentation page you're referring to.
30+
placeholder: e.g., https://docs.dify.ai/getting-started or /getting-started.md
31+
validations:
32+
required: false
33+
34+
- type: textarea
35+
id: current
36+
attributes:
37+
label: Current Content
38+
description: What does the documentation currently say?
39+
placeholder: Paste the current content here...
40+
validations:
41+
required: false
42+
43+
- type: textarea
44+
id: suggestion
45+
attributes:
46+
label: Suggested Changes
47+
description: What would you like to be changed or added?
48+
placeholder: Describe your suggested changes...
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
id: reason
54+
attributes:
55+
label: Reason for Change
56+
description: Why do you think this change would improve the documentation?
57+
placeholder: Explain why this change would be helpful...
58+
validations:
59+
required: false
60+
61+
- type: checkboxes
62+
id: terms
63+
attributes:
64+
label: Code of Conduct
65+
description: By submitting this issue, you agree to follow our contribution guidelines
66+
options:
67+
- label: I agree to follow Dify's documentation contribution guidelines
68+
required: true

0 commit comments

Comments
 (0)