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

Replacing markdown issue templates with yml forms #748

Merged
merged 15 commits into from
Nov 3, 2022
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
26 changes: 0 additions & 26 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

87 changes: 87 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# SPDX-FileCopyrightText: Copyright (c) 2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Bug Report
description: File a bug report for cuSpatial
title: "[BUG]: "
labels: ["bug", "? - Needs Triage"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to help cuSpatial and fill out this bug report!
- By submitting this issue, you agree to follow our [Code of Conduct](https://docs.rapids.ai/resources/conduct/)
- You also confirm that you have searched the [open bugs](https://github.com/rapidsai/cuspatial/issues?q=is%3Aopen+is%3Aissue+label%3Abug) and have found no duplicates for this request

- type: input
id: version
attributes:
label: Version
description: What version of cuSpatial are you running?
placeholder: "example: 22.10"
validations:
required: true

- type: dropdown
id: installation-method
attributes:
label: On which installation method(s) does this occur?
multiple: true
options:
- Docker
- Conda
- Source
jarmak-nv marked this conversation as resolved.
Show resolved Hide resolved
- Rapids-Compose

- type: textarea
id: description
attributes:
label: Describe the issue
description: Please provide a complete and succinct description of the problem, including what you expected to happen.
placeholder: XYZ occured, I expected QRS results
validations:
required: true

- type: textarea
id: mvr
attributes:
label: Minimum reproducible example
description: Please supply a [minimum reproducible code example](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) here.
render: shell

- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please paste relevant error and log output here
render: shell

- type: textarea
id: env-details
attributes:
label: Environment details
description: Please provide any relevant environment details
placeholder: |
Environment location: [Bare-metal, Docker, Cloud(specify cloud provider)]
If method of install is Docker, provide `docker pull` & `docker run` commands used
jarmak-nv marked this conversation as resolved.
Show resolved Hide resolved
render: shell

- type: textarea
id: misc
attributes:
label: Other/Misc.
description: Please enter any other helpful information here.

35 changes: 0 additions & 35 deletions .github/ISSUE_TEMPLATE/documentation-request.md

This file was deleted.

64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# SPDX-FileCopyrightText: Copyright (c) 2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Documentation Request
description: Request updates or additions to cuSpatial's documentation
title: "[DOC]: "
labels: ["doc", "? - Needs Triage"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to help cuSpatial and improve our documentation!
- By submitting this issue, you agree to follow our [Code of Conduct](https://docs.rapids.ai/resources/conduct/)
- You also confirm that you have searched the [open documentation issues](https://github.com/rapidsai/cuspatial/issues?q=is%3Aopen+is%3Aissue+label%3Adoc) and have found no duplicates for this request

- type: dropdown
id: criticality
attributes:
label: How would you describe the priority of this documentation request
options:
- Critical (currently preventing usage)
- Medium
- Low (would be nice)
validations:
required: true

- type: dropdown
id: new_or_correction
attributes:
label: Is this for new documentation, or an update to existing docs?
options:
- New
- Update
validations:
required: true

- type: textarea
id: problem
attributes:
label: Describe the incorrect/future/missing documentation
placeholder: "Example: A code snippet mentions function foo(args) but I cannot find any documentation on it."
validations:
required: true

- type: textarea
id: search_locs
attributes:
label: If this is a correction, please provide a link to the incorrect documentation. If this is a new documentation request, please link to where you have looked.
placeholder: |
https://docs.rapids.ai/api/cuspatial/stable/ and
https://docs.rapids.ai/api/cuspatial/nightly
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# SPDX-FileCopyrightText: Copyright (c) 2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Feature Request
description: Request new or improved functionality or changes to existing cuSpatial functionality
title: "[FEA]: "
labels: ["feature request", "? - Needs Triage"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to help cuSpatial and fill out this feature request!
- By submitting this issue, you agree to follow our [Code of Conduct](https://docs.rapids.ai/resources/conduct/)
- You also confirm that you have searched the [open feature requests](https://github.com/rapidsai/cuspatial/issues?q=is%3Aopen+is%3Aissue+label%3A%22feature+request%22%2Cimprovement%2Cenhancement) and have found no duplicates for this request

- type: dropdown
id: new_or_improvement
attributes:
label: Is this a new feature, an improvement, or a change to existing functionality?
options:
- New Feature
- Improvement
- Change
validations:
required: true

- type: dropdown
id: criticality
attributes:
label: How would you describe the priority of this feature request
options:
- Critical (currently preventing usage)
- Medium
- Low (would be nice)
validations:
required: true

- type: textarea
id: problem
attributes:
label: Please provide a clear description of problem you would like to solve.
description: Real usage examples are especially helpful. If there is an existing function you use in a different library, please also provide a link.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Describe any alternatives you have considered
description: List any other libraries, or approaches you have looked at or tried.
placeholder: I have looked at library xyz and qrs, but they do not offer GPU accleration

- type: textarea
id: misc
attributes:
label: Additional context
description: Add any other context, code examples, or references to existing implementations about the feature request here.

10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/submit-question.md

This file was deleted.

37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/submit_question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# SPDX-FileCopyrightText: Copyright (c) 2022, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Submit Question
description: Ask a question about cuSpatial
title: "[QST]: "
labels: ["question", "? - Needs Triage"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to ask us a question!
- By submitting this issue, you agree to follow our [Code of Conduct](https://docs.rapids.ai/resources/conduct/)
- You also confirm that you have searched the [open questions](https://github.com/rapidsai/cuspatial/issues?q=is%3Aopen+is%3Aissue+label%3Aquestion) and have found no duplicate questions

- type: textarea
id: question
attributes:
label: What is your question?
description: Please be specific and we will answer your question as soon as possible.
placeholder: Does cuSpatial integrate with XYZ software?
validations:
required: true