|
| 1 | +name: Bug Report |
| 2 | +description: Create a report about an error to help us improve |
| 3 | + |
| 4 | +type: bug |
| 5 | +body: |
| 6 | + - type: markdown |
| 7 | + attributes: |
| 8 | + value: > |
| 9 | + Thanks for taking the time to contribute to icepyx by filling out this bug report! We appreciate |
| 10 | + your help in improving icepyx and making data more accessible. |
| 11 | +
|
| 12 | + - type: textarea |
| 13 | + id: what-happened |
| 14 | + attributes: |
| 15 | + label: Describe the bug |
| 16 | + description: | |
| 17 | + A clear and concise description of what the problem is. In 1-3 sentences, summarize what you were |
| 18 | + trying to accomplish and what happened instead. |
| 19 | + placeholder: | |
| 20 | + Example: While attempting to download 2 granules using `region.download_granules()` I got an error |
| 21 | + informing me that I needed to login, but I had already provided my login information. |
| 22 | +
|
| 23 | + Example: While searching for data using `ipx.Query()` using the `spatial_extent` filter but upon |
| 24 | + opening my files I see that some of the granules are located outside the specified spatial extent. |
| 25 | + validations: |
| 26 | + required: true |
| 27 | + |
| 28 | + - type: textarea |
| 29 | + id: expected |
| 30 | + attributes: |
| 31 | + label: Expected behavior |
| 32 | + description: | |
| 33 | + A clear and concise description of what you expected to happen. |
| 34 | + placeholder: | |
| 35 | + I expected 12 granules. The granules ids I expected were ... |
| 36 | +
|
| 37 | + - type: textarea |
| 38 | + id: sample-code |
| 39 | + attributes: |
| 40 | + label: Reproducible Example |
| 41 | + description: > |
| 42 | + Minimal, contained code snippet that describes the problem (also known as an MRE, or Minimal Reproducible Example). |
| 43 | + See more about creating MREs [here](https://matthewrocklin.com/minimal-bug-reports/#do_3). If you're not sure how to |
| 44 | + create an MRE just paste your best version of an MRE and we will discuss your example in the issue comments. Be |
| 45 | + sure to include granule ids if your issue pertains to a specific granule. |
| 46 | +
|
| 47 | + This will be automatically formatted into code, so no need for markdown backticks. |
| 48 | + render: Python |
| 49 | + value: | |
| 50 | + import icepyx as ipx |
| 51 | +
|
| 52 | + # your minimal reproducible code ... |
| 53 | +
|
| 54 | + - type: input |
| 55 | + id: version |
| 56 | + attributes: |
| 57 | + label: Version |
| 58 | + description: | |
| 59 | + What version of icepyx are you using? |
| 60 | +
|
| 61 | + If you're not sure what version of icepyx you're using, run `ipx.__version__` from a Python file |
| 62 | + after importing icepyx |
| 63 | + placeholder: v2.0.1 |
| 64 | + |
| 65 | + - type: input |
| 66 | + id: sys-info |
| 67 | + attributes: |
| 68 | + label: System Information |
| 69 | + description: What type of operating system are you using? |
| 70 | + placeholder: Ex. Apple, Dell, Cryocloud, ... |
| 71 | + |
| 72 | + - type: textarea |
| 73 | + id: logs |
| 74 | + attributes: |
| 75 | + label: Relevant log output |
| 76 | + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. |
| 77 | + render: shell |
| 78 | + |
| 79 | + - type: textarea |
| 80 | + id: screenshots |
| 81 | + attributes: |
| 82 | + label: screenshots |
| 83 | + description: If applicable, add screenshots to help explain your problem. |
| 84 | + |
| 85 | + - type: checkboxes |
| 86 | + id: terms |
| 87 | + attributes: |
| 88 | + label: Code of Conduct |
| 89 | + 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). |
| 90 | + options: |
| 91 | + - label: I agree to follow this project's Code of Conduct |
| 92 | + required: true |
0 commit comments