Skip to content

Commit 0376fd0

Browse files
Add new template for documentation issues
1 parent 692593b commit 0376fd0

File tree

2 files changed

+20
-3
lines changed

2 files changed

+20
-3
lines changed

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
blank_issues_enabled: true
22
contact_links:
3-
- name: Propose a new major feature
3+
- name: Propose a new major feature
44
url: https://github.com/zarr-developers/zarr-specs
55
about: A new major feature should be discussed in the Zarr specifications repository.
6-
- name: Discuss something on gitter
6+
- name: Discuss something on gitter
77
url: https://gitter.im/zarr-developers/community
88
about: For questions like "How do I do X with Zarr?", you can move to our Gitter channel.
9-
- name: Discuss something on GitHub Discussions
9+
- name: Discuss something on GitHub Discussions
1010
url: https://github.com/zarr-developers/zarr-python/discussions
1111
about: For questions like "How do I do X with Zarr?", you can move to GitHub Discussions.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Documentation Improvement
2+
description: Report missing or wrong documentation. Alternatively, you can just open a pull request with the suggested change.
3+
labels: [documentation, help wanted]
4+
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Describe the issue linked to the documentation
9+
description: >
10+
Please provide a description of what documentation you believe needs to be fixed/improved.
11+
validations:
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Suggested fix for documentation
16+
description: >
17+
Please explain the suggested fix and why it's better than the existing documentation.

0 commit comments

Comments
 (0)