-
-
Notifications
You must be signed in to change notification settings - Fork 273
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added a new issue template for documentation issues (#2255)
* Add new template for documentation issues * Minor fix * Minor fix * Change language * Minor fix
- Loading branch information
1 parent
177a8c2
commit c52614a
Showing
3 changed files
with
23 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,11 @@ | ||
blank_issues_enabled: true | ||
contact_links: | ||
- name: ✨ Propose a new major feature | ||
- name: Propose a new major feature | ||
url: https://github.com/zarr-developers/zarr-specs | ||
about: A new major feature should be discussed in the Zarr specifications repository. | ||
- name: ❓ Discuss something on ZulipChat | ||
- name: Discuss something on ZulipChat | ||
url: https://ossci.zulipchat.com/ | ||
about: For questions like "How do I do X with Zarr?", you can move to our ZulipChat. | ||
- name: ❓ Discuss something on GitHub Discussions | ||
- name: Discuss something on GitHub Discussions | ||
url: https://github.com/zarr-developers/zarr-python/discussions | ||
about: For questions like "How do I do X with Zarr?", you can move to GitHub Discussions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
name: Documentation Improvement | ||
description: Report missing or wrong documentation. Alternatively, you can just open a pull request with the suggested change. | ||
title: "DOC: " | ||
labels: [documentation, help wanted] | ||
|
||
body: | ||
- type: textarea | ||
attributes: | ||
label: Describe the issue linked to the documentation | ||
description: > | ||
Please provide a description of what documentation you believe needs to be fixed/improved. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Suggested fix for documentation | ||
description: > | ||
Please explain the suggested fix and why it's better than the existing documentation. |