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 Q&A GH discussions template #479

Merged
merged 7 commits into from
May 17, 2023
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
53 changes: 53 additions & 0 deletions .github/DISCUSSION_TEMPLATE/q-a.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Q&A
description: Ask the community for help
body:
- type: textarea
id: your-question
attributes:
label: Describe your question
description: |
Please help the community help you. The more specific you can be, the easier it will be to help.
validations:
required: true

- type: textarea
id: possible-answers
attributes:
label: Are there are any possible answers you came across?
description: |
This will help others determine if you're on the right track. Include links to pages you've researched (e.g., software docs, Stack Overflow posts).

- type: textarea
id: sample-code
attributes:
label: Minimal Complete Verifiable Example (MVCE)
description: |
Minimal, self-contained copy-pastable example that generates the question/issue if possible. Please be concise with code posted (e.g., module imports, publicly accessible files).
Examples that follow these guidelines are easier to parse. This section will be automatically formatted into code, so no need for markdown backticks.

See guidelines below on how to provide a good MCVE:

- [Minimal Complete Verifiable Examples](https://stackoverflow.com/help/mcve)
- [Craft Minimal Bug Reports](http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
render: python

- type: textarea
id: log-output
attributes:
label: Relevant log output
description: Please copy and paste any relevant output. This will be automatically formatted into code, so no need for markdown backticks.
render: python

- type: textarea
id: show-versions
attributes:
label: Environment
description: |
If an MVCE and log output was provided, paste your xCDAT version and the output `xr.show_versions()`. here

- type: textarea
id: extra
attributes:
label: Anything else we need to know?
description: |
Please describe any other information you want to share.
18 changes: 9 additions & 9 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,24 +17,24 @@ body:
- type: textarea
id: what-did-you-expect-to-happen
attributes:
label: What did you expect to happen?
label: What did you expect to happen? Are there are possible answers you came across?
description: |
Describe what you expected to happen.
Describe what you expected to happen. Include links to pages you've researched (e.g., software docs, Stack Overflow posts).
validations:
required: false

- type: textarea
id: sample-code
attributes:
label: Minimal Complete Verifiable Example
label: Minimal Complete Verifiable Example (MVCE)
description: |
Minimal, self-contained copy-pastable example that generates the issue if possible. Please be concise with code posted. See guidelines below on how to provide a good bug report:
Minimal, self-contained copy-pastable example that generates the issue if possible. Please be concise with code posted (e.g., module imports, publicly accessible files).
Bug reports that follow these guidelines are easier to diagnose, and so are often handled much more quickly. This section will be automatically formatted into code, so no need for markdown backticks.

- [Minimal Complete Verifiable Examples](https://stackoverflow.com/help/mcve)
- [Craft Minimal Bug Reports](http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
See guidelines below on how to provide a good MCVE:

Bug reports that follow these guidelines are easier to diagnose, and so are often handled much more quickly.
This will be automatically formatted into code, so no need for markdown backticks.
- [Minimal Complete Verifiable Examples](https://stackoverflow.com/help/mcve)
- [Craft Minimal Bug Reports](http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
render: python

- type: textarea
Expand All @@ -56,6 +56,6 @@ body:
attributes:
label: Environment
description: |
Paste your xCDAT version and the output `xr.show_versions()` here
Paste your xCDAT version and the output `xr.show_versions()` here.
validations:
required: true
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
blank_issues_enabled: true
contact_links:
- name: Usage question (xCDAT)
- name: Questions (xCDAT)
url: https://github.com/xCDAT/xcdat/discussions
about: |
Ask questions and discuss with other xCDAT community members here. Please
Expand All @@ -9,7 +9,7 @@ contact_links:
answer, please include a self-contained reproducible example with your
question if possible. Thanks!

- name: Usage question (xarray)
- name: Questions (xarray)
url: https://github.com/pydata/xarray/discussions
about: |
If your questions or discussions are related to xarray, please visit this page
Expand Down
Loading