Skip to content

Commit

Permalink
Add YAML files for issue tracker (#1079)
Browse files Browse the repository at this point in the history
* 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 <jakirkham@gmail.com>

* Update `config.yml` with more links

* Make texts uniform and add unicode characters

Co-authored-by: jakirkham <jakirkham@gmail.com>
  • Loading branch information
Saransh-cpp and jakirkham committed Jul 21, 2022
1 parent ece1810 commit dcc6ded
Show file tree
Hide file tree
Showing 4 changed files with 82 additions and 28 deletions.
28 changes: 0 additions & 28 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: 🐛 File a bug report
description: X's behavior is deviating from its documented behavior.
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Please provide the following information.
- type: input
id: Zarr-version
attributes:
label: Zarr version
description: Value of ``zarr.__version__``
placeholder: v2.10.2, v2.11.3, v2.12.0, etc.
validations:
required: true
- type: input
id: Numcodecs-version
attributes:
label: Numcodecs version
description: Value of ``numcodecs.__version__``
placeholder: v0.8.1, v0.9.0, v0.10.0, etc.
validations:
required: true
- type: input
id: Python-version
attributes:
label: Python Version
description: Version of Python interpreter
placeholder: 3.8.5, 3.9, 3.10, etc.
validations:
required: true
- type: input
id: OS
attributes:
label: Operating System
description: Operating System
placeholder: (Linux/Windows/Mac)
validations:
required: true
- type: input
id: installation
attributes:
label: Installation
description: How was Zarr installed?
placeholder: e.g., "using pip into virtual environment", or "using conda"
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
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.
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Steps to reproduce
description: Minimal, reproducible code sample, a copy-pastable example if possible.
validations:
required: true
- type: textarea
id: additional-output
attributes:
label: Additional output
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.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: true
contact_links:
- 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 gitter
url: https://gitter.im/zarr-developers/community
about: For questions like "How do I do X with Zarr?", you can move to our Gitter channel.
- 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.
4 changes: 4 additions & 0 deletions docs/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ Maintenance
* Fix spelling.
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>`, :issue:`1073`.

* Update GitHub issue templates with `YAML` format.
By :user:`Saransh Chopra <Saransh-cpp>` :issue:`1079`.


.. _release_2.12.0:

2.12.0
Expand Down

0 comments on commit dcc6ded

Please sign in to comment.