Skip to content

Commit c52614a

Browse files
Added a new issue template for documentation issues (#2255)
* Add new template for documentation issues * Minor fix * Minor fix * Change language * Minor fix
1 parent 177a8c2 commit c52614a

File tree

3 files changed

+23
-5
lines changed

3 files changed

+23
-5
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
name: 🐛 File a bug report
2-
description: X's behavior is deviating from its documented behavior.
1+
name: Bug Report
2+
description: Report incorrect behaviour in the library.
33
labels: ["bug"]
44
body:
55
- type: markdown

.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 ZulipChat
6+
- name: Discuss something on ZulipChat
77
url: https://ossci.zulipchat.com/
88
about: For questions like "How do I do X with Zarr?", you can move to our ZulipChat.
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: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Documentation Improvement
2+
description: Report missing or wrong documentation. Alternatively, you can just open a pull request with the suggested change.
3+
title: "DOC: "
4+
labels: [documentation, help wanted]
5+
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Describe the issue linked to the documentation
10+
description: >
11+
Please provide a description of what documentation you believe needs to be fixed/improved.
12+
validations:
13+
required: true
14+
- type: textarea
15+
attributes:
16+
label: Suggested fix for documentation
17+
description: >
18+
Please explain the suggested fix and why it's better than the existing documentation.

0 commit comments

Comments
 (0)