Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add getting help section #195

Merged
merged 4 commits into from
Jan 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: Bug Report
description: File a bug report for Xee.
title: "[Bug]: "
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: Bug Summary
description: At a high level, described what happened.
placeholder: Describe what happened...
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: |
1. Create a [minimal reproducible](https://stackoverflow.com/help/minimal-reproducible-example) example in Colab, using this [template](https://colab.research.google.com/drive/1vAgfAPhKGJd4G9ZUOzciqZ7MbqJjlMLR).
2. Make the notebook publicly accessible.
3. Make sure that any datasets needed to reproduce the bug are publicly shared. If the datasets are sensitive and cannot be made public, replace them with other public datasets.
4. Copy the notebook URL below.
placeholder: Provide a Colab notebook URL and/or a detailed description of how to reproduce the bug.
validations:
required: true
- type: textarea
id: current-behavior
attributes:
label: Current Behavior
description: Describe what is currently happening.
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: Describe what you expect to happen.
validations:
required: true
- 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: input
id: version
attributes:
label: Xee Version
description: What version of Xee are you running?
validations:
required: true
- type: input
id: contact
attributes:
label: Contact Details
description: (OPTIONAL) How can we get in touch with you if we need more info?
placeholder: ex. [email protected]
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com).
options:
- label: I agree to follow this project's Code of Conduct
required: true
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Feature Request (enhancement)
description: File a feature request for Xee.
title: "[FR]: "
labels: ["enhancement", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature enhancement request!
- type: textarea
id: feature-summary
attributes:
label: Feature Summary
description: Describe this feature.
validations:
required: true
- type: textarea
id: use-cases
attributes:
label: Use Cases
description: Provide details about situations or use cases where this feature would be valuable.
validations:
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Discussions
url: https://github.com/google/Xee/discussions
about: Ask and answer questions with the Xee community.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,13 @@ ds = xr.open_dataset(

See [examples](https://github.com/google/Xee/tree/main/examples) or [docs](https://github.com/google/Xee/tree/main/docs) for more uses and integrations.

## Getting help

If you encounter issues using Xee, you can:

1. Open a new or add to an existing [Xee discussion topic](https://github.com/google/Xee/discussions)
2. Open an [Xee issue](https://github.com/google/Xee/issues). To increase the likelihood of the issue being resolved, use this [template Colab notebook](https://colab.research.google.com/drive/1vAgfAPhKGJd4G9ZUOzciqZ7MbqJjlMLR) to create a reproducible script.

## How to run integration tests

The Xee integration tests only pass on Xee branches (no forks). Please run the
Expand Down
Loading