From 9de6ac2a5cf4ec9b4d1be5942b9ca6625cddd436 Mon Sep 17 00:00:00 2001 From: Jessica Scheick Date: Fri, 5 Dec 2025 15:22:09 -0500 Subject: [PATCH 01/11] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..dd84ea782 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..bbcbbe7d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. From bdd021919ea827cbfe69ab75bd09af0dae04b4e0 Mon Sep 17 00:00:00 2001 From: Rachel Wegener Date: Thu, 11 Dec 2025 09:51:54 -0600 Subject: [PATCH 02/11] add icepyx specific bug report template --- .github/ISSUE_TEMPLATE/bug_report.yml | 88 +++++++++++++++++++++++++++ 1 file changed, 88 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..16b00c58b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,88 @@ +name: Bug Report +description: Create a report about an error to help us improve +title: "" +labels: "" +projects: "" +assignees: "" + +type: bug +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to contribute to icepyx by filling out this bug report! We appreciate + your help in improving icepyx and making data more accessible. + + - type: textarea + id: what-happened + attributes: + label: Describe the bug + description: | + A clear and concise description of what the problem is. In 1-3 sentences, summarize what you were + trying to accomplish and what happened instead. + placeholder: | + Example: While attempting to download 2 granules using `region.download_granules()` I got an error + informing me that I needed to login, but I had already provided my login information. + + Example: While searching for data using `ipx.Query()` using the `spatial_extent` filter but upon + opening my files I see that some of the granules are located outside the specified spatial extent. + + - type: textarea + id: expected + attributes: + label: Expected behavior + description: | + A clear and concise description of what you expected to happen. + placeholder: | + I expected 12 granules. The granules ids I expected were ... + + - type: textarea + id: sample-code + attributes: + label: Reproducible Example + description: | + Minimal, contained code snippet that describes the problem (also known as an MRE, or Minimal Reproducible Example). + See more about creating MREs [here](https://matthewrocklin.com/minimal-bug-reports/#do_3). If you're not sure how to + create an MRE just paste your best version of an MRE and if we will discuss your example in the issue comments. Be + sure to include granule ids if your issue pertains to a specific granule. + + This will be automatically formatted into code, so no need for markdown backticks. + render: Python + value: | + import icepyx as ipx + + # your minimal reproducible code ... + + - type: input + id: version + attributes: + label: Version + description: | + What version of icepyx are you using? + + If you're not sure what version of icepyx you're using, run `ipx.__version__` from a Python file + after importing icepyx + placeholder: v2.0.1 + + - type: input + id: sys-info + attributes: + label: System Information + description: What type of operating system are you using? + placeholder: Ex. Apple, Dell, Cryocloud, ... + + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://icepyx.readthedocs.io/en/latest/contributing/code_of_conduct_link.html). + options: + - label: I agree to follow this project's Code of Conduct + required: true From 57c71a54a986c38633c0a49f20c71ee1128016e0 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 11 Dec 2025 15:53:14 +0000 Subject: [PATCH 03/11] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .github/ISSUE_TEMPLATE/bug_report.yml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 16b00c58b..daaf77ebb 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -10,7 +10,7 @@ body: - type: markdown attributes: value: | - Thanks for taking the time to contribute to icepyx by filling out this bug report! We appreciate + Thanks for taking the time to contribute to icepyx by filling out this bug report! We appreciate your help in improving icepyx and making data more accessible. - type: textarea @@ -18,14 +18,14 @@ body: attributes: label: Describe the bug description: | - A clear and concise description of what the problem is. In 1-3 sentences, summarize what you were + A clear and concise description of what the problem is. In 1-3 sentences, summarize what you were trying to accomplish and what happened instead. placeholder: | - Example: While attempting to download 2 granules using `region.download_granules()` I got an error + Example: While attempting to download 2 granules using `region.download_granules()` I got an error informing me that I needed to login, but I had already provided my login information. - + Example: While searching for data using `ipx.Query()` using the `spatial_extent` filter but upon - opening my files I see that some of the granules are located outside the specified spatial extent. + opening my files I see that some of the granules are located outside the specified spatial extent. - type: textarea id: expected @@ -35,14 +35,14 @@ body: A clear and concise description of what you expected to happen. placeholder: | I expected 12 granules. The granules ids I expected were ... - + - type: textarea id: sample-code attributes: label: Reproducible Example description: | - Minimal, contained code snippet that describes the problem (also known as an MRE, or Minimal Reproducible Example). - See more about creating MREs [here](https://matthewrocklin.com/minimal-bug-reports/#do_3). If you're not sure how to + Minimal, contained code snippet that describes the problem (also known as an MRE, or Minimal Reproducible Example). + See more about creating MREs [here](https://matthewrocklin.com/minimal-bug-reports/#do_3). If you're not sure how to create an MRE just paste your best version of an MRE and if we will discuss your example in the issue comments. Be sure to include granule ids if your issue pertains to a specific granule. @@ -77,7 +77,7 @@ body: label: Relevant log output description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. render: shell - + - type: checkboxes id: terms attributes: From a0d0c12cb413457a040793d6447d2da7c867e9cf Mon Sep 17 00:00:00 2001 From: Rachel Wegener Date: Thu, 11 Dec 2025 11:05:48 -0600 Subject: [PATCH 04/11] remove md bug report and tailor feature request template --- .github/ISSUE_TEMPLATE/bug_report.md | 38 ----------------------- .github/ISSUE_TEMPLATE/bug_report.yml | 10 +++++- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 3 files changed, 10 insertions(+), 40 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index dd84ea782..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index daaf77ebb..8ada290ea 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -26,6 +26,8 @@ body: Example: While searching for data using `ipx.Query()` using the `spatial_extent` filter but upon opening my files I see that some of the granules are located outside the specified spatial extent. + validations: + required: true - type: textarea id: expected @@ -77,7 +79,13 @@ body: label: Relevant log output description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. render: shell - + + - type: textarea + id: screenshots + attributes: + label: screenshots + description: If applicable, add screenshots to help explain your problem. + - type: checkboxes id: terms attributes: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7d6..02c52904e 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,6 +1,6 @@ --- name: Feature request -about: Suggest an idea for this project +about: Suggest an idea for a new icepyx feature title: '' labels: '' assignees: '' From 0dfeea65f031e8376b0756388d653c57659244a3 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 11 Dec 2025 17:09:20 +0000 Subject: [PATCH 05/11] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 8ada290ea..a1ff1ed12 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -79,13 +79,13 @@ body: label: Relevant log output description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. render: shell - + - type: textarea id: screenshots attributes: label: screenshots description: If applicable, add screenshots to help explain your problem. - + - type: checkboxes id: terms attributes: From 739eac34928fcaa40166a5b3c697c2da8453638c Mon Sep 17 00:00:00 2001 From: Rachel Wegener Date: Mon, 15 Dec 2025 08:48:55 -0600 Subject: [PATCH 06/11] fix formatting errors --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index a1ff1ed12..e46c5d64d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,9 +1,5 @@ name: Bug Report description: Create a report about an error to help us improve -title: "" -labels: "" -projects: "" -assignees: "" type: bug body: From dcea10972a9f2e11ca56993f1917adee6f3135ad Mon Sep 17 00:00:00 2001 From: Rachel Wegener <35503632+rwegener2@users.noreply.github.com> Date: Mon, 15 Dec 2025 15:09:27 -0600 Subject: [PATCH 07/11] Apply suggestions from code review Co-authored-by: Jessica Scheick --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index e46c5d64d..dfd872f10 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -38,10 +38,10 @@ body: id: sample-code attributes: label: Reproducible Example - description: | + description: > Minimal, contained code snippet that describes the problem (also known as an MRE, or Minimal Reproducible Example). See more about creating MREs [here](https://matthewrocklin.com/minimal-bug-reports/#do_3). If you're not sure how to - create an MRE just paste your best version of an MRE and if we will discuss your example in the issue comments. Be + create an MRE just paste your best version of an MRE and we will discuss your example in the issue comments. Be sure to include granule ids if your issue pertains to a specific granule. This will be automatically formatted into code, so no need for markdown backticks. From 989642ada1133c7c3258c5bf3c8fa6324b06f476 Mon Sep 17 00:00:00 2001 From: Rachel Wegener Date: Mon, 15 Dec 2025 15:22:05 -0600 Subject: [PATCH 08/11] standardize formatting --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yml | 40 ++++++++++++++++++++++ 2 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index dfd872f10..4cef88910 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -5,7 +5,7 @@ type: bug body: - type: markdown attributes: - value: | + value: > Thanks for taking the time to contribute to icepyx by filling out this bug report! We appreciate your help in improving icepyx and making data more accessible. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..890f80e77 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,40 @@ +name: Feature request +description: Suggest an idea for a new icepyx feature + +type: bug +body: + - type: markdown + attributes: + value: > + Thanks for taking the time to contribute to icepyx by requesting a feature! We appreciate + your help in improving icepyx and making data more accessible. + + - type: textarea + id: feature-description + attributes: + label: Is your feature request related to a problem? Please describe. + description: | + A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: | + A clear and concise description of what you want to happen. + + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered + description: | + A clear and concise description of any alternative solutions or features you've considered. + + - type: textarea + id: context + attributes: + label: Additional context + description: | + Add any other context or screenshots about the feature request here. From f945fd9aca9e0454dc83d94fcf1a443bf7e19753 Mon Sep 17 00:00:00 2001 From: Rachel Wegener Date: Mon, 15 Dec 2025 15:24:14 -0600 Subject: [PATCH 09/11] remove old version of feature request template --- .github/ISSUE_TEMPLATE/feature_request.md | 20 -------------------- 1 file changed, 20 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 02c52904e..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for a new icepyx feature -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. From cd8d1768660b46709d5608fcda4bd10e398da63c Mon Sep 17 00:00:00 2001 From: Rachel Wegener Date: Mon, 15 Dec 2025 15:47:09 -0600 Subject: [PATCH 10/11] add code of conduct agreement --- .github/ISSUE_TEMPLATE/feature_request.yml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 890f80e77..0c7146fe6 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -38,3 +38,12 @@ body: label: Additional context description: | Add any other context or screenshots about the feature request here. + + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://icepyx.readthedocs.io/en/latest/contributing/code_of_conduct_link.html). + options: + - label: I agree to follow this project's Code of Conduct + required: true \ No newline at end of file From 53e29f6008d6ae839b62ecf7ed00b47e9f21ec19 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 15 Dec 2025 21:47:19 +0000 Subject: [PATCH 11/11] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 0c7146fe6..1a5f770c9 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -46,4 +46,4 @@ body: description: By submitting this issue, you agree to follow our [Code of Conduct](https://icepyx.readthedocs.io/en/latest/contributing/code_of_conduct_link.html). options: - label: I agree to follow this project's Code of Conduct - required: true \ No newline at end of file + required: true