Skip to content

Commit dcc6ded

Browse files
Add YAML files for issue tracker (#1079)
* Add a `YAML` file for the bug report template * Add gitter and discussion tab reference * Minor bug fix, ironical * Update `release.rst` * Update .github/ISSUE_TEMPLATE/config.yml Co-authored-by: jakirkham <[email protected]> * Update `config.yml` with more links * Make texts uniform and add unicode characters Co-authored-by: jakirkham <[email protected]>
1 parent ece1810 commit dcc6ded

File tree

4 files changed

+82
-28
lines changed

4 files changed

+82
-28
lines changed

.github/ISSUE_TEMPLATE.md

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

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: 🐛 File a bug report
2+
description: X's behavior is deviating from its documented behavior.
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Please provide the following information.
9+
- type: input
10+
id: Zarr-version
11+
attributes:
12+
label: Zarr version
13+
description: Value of ``zarr.__version__``
14+
placeholder: v2.10.2, v2.11.3, v2.12.0, etc.
15+
validations:
16+
required: true
17+
- type: input
18+
id: Numcodecs-version
19+
attributes:
20+
label: Numcodecs version
21+
description: Value of ``numcodecs.__version__``
22+
placeholder: v0.8.1, v0.9.0, v0.10.0, etc.
23+
validations:
24+
required: true
25+
- type: input
26+
id: Python-version
27+
attributes:
28+
label: Python Version
29+
description: Version of Python interpreter
30+
placeholder: 3.8.5, 3.9, 3.10, etc.
31+
validations:
32+
required: true
33+
- type: input
34+
id: OS
35+
attributes:
36+
label: Operating System
37+
description: Operating System
38+
placeholder: (Linux/Windows/Mac)
39+
validations:
40+
required: true
41+
- type: input
42+
id: installation
43+
attributes:
44+
label: Installation
45+
description: How was Zarr installed?
46+
placeholder: e.g., "using pip into virtual environment", or "using conda"
47+
validations:
48+
required: true
49+
- type: textarea
50+
id: description
51+
attributes:
52+
label: Description
53+
description: Explain why the current behavior is a problem, what the expected output/behaviour is, and why the expected output/behaviour is a better solution.
54+
validations:
55+
required: true
56+
- type: textarea
57+
id: reproduce
58+
attributes:
59+
label: Steps to reproduce
60+
description: Minimal, reproducible code sample, a copy-pastable example if possible.
61+
validations:
62+
required: true
63+
- type: textarea
64+
id: additional-output
65+
attributes:
66+
label: Additional output
67+
description: If you think it might be relevant, please provide the output from ``pip freeze`` or ``conda env export`` depending on which was used to install Zarr.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: ✨ Propose a new major feature
4+
url: https://github.com/zarr-developers/zarr-specs
5+
about: A new major feature should be discussed in the Zarr specifications repository.
6+
- name: ❓ Discuss something on gitter
7+
url: https://gitter.im/zarr-developers/community
8+
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
10+
url: https://github.com/zarr-developers/zarr-python/discussions
11+
about: For questions like "How do I do X with Zarr?", you can move to GitHub Discussions.

docs/release.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ Maintenance
2525
* Fix spelling.
2626
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>`, :issue:`1073`.
2727

28+
* Update GitHub issue templates with `YAML` format.
29+
By :user:`Saransh Chopra <Saransh-cpp>` :issue:`1079`.
30+
31+
2832
.. _release_2.12.0:
2933

3034
2.12.0

0 commit comments

Comments
 (0)