From 0376fd045e244f201a57749911e960cf4b973cfc Mon Sep 17 00:00:00 2001 From: Sanket Verma Date: Thu, 26 Sep 2024 01:58:36 +0530 Subject: [PATCH 1/5] Add new template for documentation issues --- .github/ISSUE_TEMPLATE/config.yml | 6 +++--- .github/ISSUE_TEMPLATE/documentation.yml | 17 +++++++++++++++++ 2 files changed, 20 insertions(+), 3 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 9cb5ec9a78..444fbafeee 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 gitter + - 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 + - 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/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 0000000000..3504efb9b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,17 @@ +name: Documentation Improvement +description: Report missing or wrong documentation. Alternatively, you can just open a pull request with the suggested change. +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. From 0ec39463fd589c987ea1c1458b32377303eb87b3 Mon Sep 17 00:00:00 2001 From: Sanket Verma Date: Thu, 26 Sep 2024 02:00:26 +0530 Subject: [PATCH 2/5] Minor fix --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index ba05f23fcc..6fae8a5c06 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,4 +1,4 @@ -name: 🐛 File a bug report +name: File a bug report description: X's behavior is deviating from its documented behavior. labels: ["bug"] body: From 3f4b9cad0664af2b2c8e18f3dea3fb81ded2e27c Mon Sep 17 00:00:00 2001 From: Sanket Verma Date: Thu, 26 Sep 2024 02:02:39 +0530 Subject: [PATCH 3/5] Minor fix --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 6fae8a5c06..ec9bc321c6 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,4 +1,4 @@ -name: File a bug report +name: Bug Report description: X's behavior is deviating from its documented behavior. labels: ["bug"] body: From 11e38c12e821010cbbe1275bdfe96dbd087ff8e9 Mon Sep 17 00:00:00 2001 From: Sanket Verma Date: Thu, 26 Sep 2024 02:07:34 +0530 Subject: [PATCH 4/5] Change language --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index ec9bc321c6..2e11f14613 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,5 +1,5 @@ name: Bug Report -description: X's behavior is deviating from its documented behavior. +description: Report incorrect behaviour in the library. labels: ["bug"] body: - type: markdown From b76da4343773f121abf053eba08441af737bc868 Mon Sep 17 00:00:00 2001 From: Sanket Verma Date: Thu, 26 Sep 2024 02:13:40 +0530 Subject: [PATCH 5/5] Minor fix --- .github/ISSUE_TEMPLATE/documentation.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml index 3504efb9b0..c240666d1f 100644 --- a/.github/ISSUE_TEMPLATE/documentation.yml +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -1,5 +1,6 @@ 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: