diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 00000000..b54aa001 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,67 @@ +name: 🐞 Bug +description: > + A bug is an issue that differs from documentation or has unexpected behavior. +title: "[BUG] {{ title }}" +labels: + - Bug + - Needs Triage +body: + - type: checkboxes + attributes: + label: Is this issue already tracked somewhere, or is this a new report? + description: Check if a similar issue has already been reported before submitting a new one. + options: + - label: I've reviewed existing issues and couldn't find a duplicate for this problem. + required: true + + - type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: true + + - type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: true + + - type: textarea + attributes: + label: Steps To Reproduce + description: | + Steps to Reproduce + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: true + + - type: textarea + attributes: + label: Environment + description: | + Examples: + - **OS**: Ubuntu 20.04 + - **Python**: 3.11.2 + value: | + - OS: + - Python: + render: markdown + validations: + required: true + + - type: textarea + attributes: + label: Additional Context + description: | + Any additional information that might be helpful in resolving this issue, such as: + - Error messages or stack traces + - Relevant configuration files or code snippets + + Tip: You can attach files or images by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..58340781 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: 🌟 Community support + url: https://github.com/nsidc/earthaccess/discussions/categories/q-a + about: Explore this section to ask questions, share insights, and connect with others about Earthdata access and usage. + - name: 💡 Suggest a new feature + url: https://github.com/nsidc/earthaccess/discussions/new?category=ideas + about: Got a brilliant idea? Share your innovative suggestions to help us make amazing improvements! diff --git a/CHANGELOG.md b/CHANGELOG.md index 034b1d61..369af789 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,9 @@ - Deprecate `earthaccess.get_s3fs_session` and `Store.get_s3fs_session`. Use `earthaccess.get_s3_filesystem` and `Store.get_s3_filesystem`, respectively, instead ([#766](https://github.com/nsidc/earthaccess/issues/766))([**@Sherwin-14**](https://github.com/Sherwin-14)) +- Added Issue Templates([#281](https://github.com/nsidc/earthaccess/issues/281))([**@Sherwin-14**](https://github.com/Sherwin-14)) + + ## [v0.10.0] 2024-07-19