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

Added new forms for bug, feature and question #296

Merged
merged 2 commits into from
Mar 21, 2024
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
69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_form.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION. 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
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: input
id: version
attributes:
label: What is the version?
description: Tell us about DCGM-exporter version.
placeholder: "example: 3.3.5-3.4.0"
validations:
required: true
- type: textarea
id: description
attributes:
label: What happened?
description: Tell us what happened and provide as many details as possible, including logs.
validations:
required: true
- type: textarea
id: expectations
attributes:
label: What did you expect to happen?
description: Tell us about expected behaviour.
validations:
required: true
- type: textarea
id: model
attributes:
label: What is the GPU model?
description: Tell us about the hardware configuration of the GPU, including the output of 'nvidia-smi'
- type: textarea
id: environment
attributes:
label: What is the environment?
description: Is DCGM-Exporter running on bare metal or in a virtual environment, container, pod, etc?
- type: textarea
id: deployment
attributes:
label: How did you deploy the dcgm-exporter and what is the configuration?
description: Tell us how you deployed DCGM-Exporter. Did you use helm, build from source or use the GPU Operator?
- type: textarea
id: steps-to-reproduce
attributes:
label: How to reproduce the issue?
description: Clear and concise steps to reproduce an issue can help everyone by allowing us to identify and fix problems more quickly.
- type: textarea
id: misc
attributes:
label: Anything else we need to know?
description: Any small detail can help.
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# GitHub info on config.yml
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
# Set to 'false' if you only want the templates to be used.
blank_issues_enabled: true
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request_form.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION. 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 Form
description: Request new or improved functionality or changes to existing functionality
labels: ["enhancement"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature 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: textarea
id: problem
attributes:
label: Please provide a clear description of the problem this feature solves
description: Real usage examples are especially helpful, non-code.
validations:
required: true

- type: textarea
id: Feature_Description
attributes:
label: Feature Description
description: Provide a clear description of the requested feature.
placeholder: >
For new feature requests, please use one of the following formats to describe the feature
1. From End-user perspective, use the following user story format
As a <persona>, I <want to>, <so that>.
2. From System perspective, use the following EARS format
<Pre-Condition> <System> shall <process> <object to be process> <condition>
validations:
required: true
- type: textarea
id: solution
attributes:
label: Describe your ideal solution
description: Please describe the functionality you would like added.
placeholder: >
How would you see an ideal solution?
validations:
required: true
- 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.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/submit-question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION. 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 general question about DCGM-exporter
labels: ["question"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this question!

- type: textarea
id: description
attributes:
label: Ask your question
description: What is your question?
validations:
required: true
Loading