Skip to content

Commit 065db79

Browse files
author
Xee authors
committed
Merge pull request #195 from tylere:main
PiperOrigin-RevId: 712981118
2 parents 6c96db5 + a3f9322 commit 065db79

File tree

4 files changed

+107
-0
lines changed

4 files changed

+107
-0
lines changed

.github/ISSUE_TEMPLATE/1-bug.yml

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
name: Bug Report
2+
description: File a bug report for Xee.
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
- type: textarea
11+
id: what-happened
12+
attributes:
13+
label: Bug Summary
14+
description: At a high level, described what happened.
15+
placeholder: Describe what happened...
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: steps-to-reproduce
20+
attributes:
21+
label: Steps to Reproduce
22+
description: |
23+
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).
24+
2. Make the notebook publicly accessible.
25+
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.
26+
4. Copy the notebook URL below.
27+
placeholder: Provide a Colab notebook URL and/or a detailed description of how to reproduce the bug.
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: current-behavior
32+
attributes:
33+
label: Current Behavior
34+
description: Describe what is currently happening.
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: expected-behavior
39+
attributes:
40+
label: Expected Behavior
41+
description: Describe what you expect to happen.
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: logs
46+
attributes:
47+
label: Relevant log output
48+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
49+
render: shell
50+
- type: input
51+
id: version
52+
attributes:
53+
label: Xee Version
54+
description: What version of Xee are you running?
55+
validations:
56+
required: true
57+
- type: input
58+
id: contact
59+
attributes:
60+
label: Contact Details
61+
description: (OPTIONAL) How can we get in touch with you if we need more info?
62+
placeholder: ex. email@example.com
63+
validations:
64+
required: false
65+
- type: checkboxes
66+
id: terms
67+
attributes:
68+
label: Code of Conduct
69+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com).
70+
options:
71+
- label: I agree to follow this project's Code of Conduct
72+
required: true
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Feature Request (enhancement)
2+
description: File a feature request for Xee.
3+
title: "[FR]: "
4+
labels: ["enhancement", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this feature enhancement request!
10+
- type: textarea
11+
id: feature-summary
12+
attributes:
13+
label: Feature Summary
14+
description: Describe this feature.
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: use-cases
19+
attributes:
20+
label: Use Cases
21+
description: Provide details about situations or use cases where this feature would be valuable.
22+
validations:
23+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Discussions
4+
url: https://github.com/google/Xee/discussions
5+
about: Ask and answer questions with the Xee community.

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,13 @@ ds = xr.open_dataset(
109109

110110
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.
111111

112+
## Getting help
113+
114+
If you encounter issues using Xee, you can:
115+
116+
1. Open a new or add to an existing [Xee discussion topic](https://github.com/google/Xee/discussions)
117+
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.
118+
112119
## How to run integration tests
113120

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

0 commit comments

Comments
 (0)