From dcc6ded4cb9b9fcc24e69b5fd5d898e97e0630dd Mon Sep 17 00:00:00 2001 From: Saransh Date: Thu, 21 Jul 2022 18:15:24 +0530 Subject: [PATCH] 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 * Update `config.yml` with more links * Make texts uniform and add unicode characters Co-authored-by: jakirkham --- .github/ISSUE_TEMPLATE.md | 28 ----------- .github/ISSUE_TEMPLATE/bug_report.yml | 67 +++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 +++++ docs/release.rst | 4 ++ 4 files changed, 82 insertions(+), 28 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 9f8b2348c..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,28 +0,0 @@ -For bug reports, please follow the template below. For enhancement proposals, feel free -to use whatever template makes sense (major new features should be discussed in the -Zarr specifications repository https://github.com/zarr-developers/zarr-specs). - -#### Minimal, reproducible code sample, a copy-pastable example if possible - -```python -# Your code here - -``` - -#### Problem 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. - -#### Version and installation information - -Please provide the following: - -* Value of ``zarr.__version__`` -* Value of ``numcodecs.__version__`` -* Version of Python interpreter -* Operating system (Linux/Windows/Mac) -* How Zarr was installed (e.g., "using pip into virtual environment", or "using conda") - -Also, 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. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..ba05f23fc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..3ce158738 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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. diff --git a/docs/release.rst b/docs/release.rst index b729f20ee..77243ff39 100644 --- a/docs/release.rst +++ b/docs/release.rst @@ -25,6 +25,10 @@ Maintenance * Fix spelling. By :user:`Dimitri Papadopoulos Orfanos `, :issue:`1073`. +* Update GitHub issue templates with `YAML` format. + By :user:`Saransh Chopra ` :issue:`1079`. + + .. _release_2.12.0: 2.12.0