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.

Sign up for GitHub

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

Jump to bottom

Replacing markdown issue templates with yml forms #748

Merged
merged 15 commits into from
Nov 3, 2022
Merged

Replacing markdown issue templates with yml forms #748

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
6856692
Replacing markdown issue templates with yml forms
jarmak-nv Oct 21, 2022
e05de34
Correcting code of conduct to say cuSpatial
jarmak-nv Oct 21, 2022
846bf19
Adding code of conduct to QST template
jarmak-nv Oct 25, 2022
68d4595
Merge branch 'rapidsai:branch-22.12' into cuspatial-issue-forms
jarmak-nv Oct 25, 2022
6d76d3c
Apply suggestions from Mark's review
jarmak-nv Oct 27, 2022
2571e80
Remove placeholder in feature request description
jarmak-nv Oct 27, 2022
31224c0
Change wording from bug to issue
jarmak-nv Oct 28, 2022
a0e5afd
Merge branch 'rapidsai:branch-22.12' into cuspatial-issue-forms
jarmak-nv Oct 28, 2022
8ef28dd
Single doc req form and minor qst update
jarmak-nv Oct 28, 2022
f04be65
Apply suggestions from code reviews
jarmak-nv Nov 2, 2022
7f143d5
Fix yml formatting error
jarmak-nv Nov 2, 2022
f769185
Removing separate doc request forms
jarmak-nv Nov 2, 2022
33bd392
Removing checkbox confirmations
jarmak-nv Nov 2, 2022
bf837df
Removing solution textbox from feature req form
jarmak-nv Nov 2, 2022
ef96391
Removed 'High' from priority dropdown
jarmak-nv Nov 2, 2022
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
View file
Open in desktop

This file was deleted.

94 changes: 94 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# 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!

- 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: Which installation method(s) does this occur on?
jarmak-nv marked this conversation as resolved.
Show resolved Hide resolved
multiple: true
options:
- Docker
- Conda
- Source
jarmak-nv marked this conversation as resolved.
Show resolved Hide resolved

- type: textarea
id: description
attributes:
label: Describe the bug.
jarmak-nv marked this conversation as resolved.
Show resolved Hide resolved
description: Also tell us, what did you expect to happen?
jarmak-nv marked this conversation as resolved.
Show resolved Hide resolved
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
jarmak-nv marked this conversation as resolved.
Show resolved Hide resolved
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.

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://docs.rapids.ai/resources/conduct/)
options:
- label: I agree to follow cuSpatial's Code of Conduct
required: true
- label: I 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 bug report
required: true
jarmak-nv marked this conversation as resolved.
Show resolved Hide resolved
35 changes: 0 additions & 35 deletions .github/ISSUE_TEMPLATE/documentation-request.md
View file
Open in desktop

This file was deleted.

70 changes: 70 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_request_correction.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# 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 - Correction/Update Request
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
name: Documentation - Correction/Update Request
name: Report Missing or Incorrect Documentation

description: Request corrections or updates to existing cuSpatial documentation
title: "[DOC]: "
labels: ["doc", "? - Needs Triage"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to help cuSpatial and improve our documentation!

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it helpful to have two levels between lowest and highest? That's kind of like two mediums. Perhaps only have one medium, and give it a guideline like you have for highest and lowest.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's helpful because the bar we pose for critical is so high. My concern with only 3 options is so much will fall into 'medium' and I wanted to give people a minor amount of granularity between Low and Critical because this isn't cuSpatial's decision of priority, it's how the reporter feels about the priority.

I struggle with good (descriptions) for the high and medium, but I also kind of like it blank since it lets the person submitting the issue make that decision themselves. We bound the upper and lower values, and the middle ones are squishy by design.

@thomcom @isVoid - thoughts?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess I prefer two options high and low, mostly just because of decision-making pressure when working through these forms.

validations:
required: true

- type: input
id: correction_location
attributes:
label: Please provide a link or source to the relevant docs
placeholder: "ex: https://docs.rapids.ai/api/cuspatial/stable/user_guide/users.html#Input-/-Output"
jarmak-nv marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: true

- type: textarea
id: problem
attributes:
label: Describe the problems in the documentation
placeholder: The documents say to use foo.func(args) however an AttributeError is thrown
jarmak-nv marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: true

- type: textarea
id: correction
attributes:
label: (Optional) Propose a correction
placeholder: foo.func() was deprecated, replace documentation with foo.new_func()
jarmak-nv marked this conversation as resolved.
Show resolved Hide resolved

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://docs.rapids.ai/resources/conduct/)
options:
- label: I agree to follow cuSpatial's Code of Conduct
required: true
- label: I 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 bug report
required: true
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_request_new.yml
View file
Open in desktop
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 - New Documentation Request
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we just have one documentation form, "Report missing or incorrect documentation"? That seems to cover "request new".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can do that, but the fields and descriptions will be a little wonky since they need to umbrella cover new or fixes. The current templates get around this by having the user delete the part they don't want but that's not an option with forms.

I'll try some stuff out and we can see how a single form would look.

description: Request 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!

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

- type: textarea
id: problem
attributes:
label: Describe the future/missing documentation
placeholder: 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: Where have you looked?
placeholder: |
https://docs.rapids.ai/api/cuspatial/stable/ and
https://docs.rapids.ai/api/cuspatial/nightly

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://docs.rapids.ai/resources/conduct/)
options:
- label: I agree to follow cuSpatial's Code of Conduct
required: true
- label: I 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 bug report
required: true
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md
View file
Open in desktop

This file was deleted.

Loading