|
| 1 | +# SPDX-FileCopyrightText: Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved. |
| 2 | +# SPDX-License-Identifier: Apache-2.0 |
| 3 | +# |
| 4 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +# you may not use this file except in compliance with the License. |
| 6 | +# You may obtain a copy of the License at |
| 7 | +# |
| 8 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +# |
| 10 | +# Unless required by applicable law or agreed to in writing, software |
| 11 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +# See the License for the specific language governing permissions and |
| 14 | +# limitations under the License. |
| 15 | + |
| 16 | +name: Feature Request Form |
| 17 | +description: Request new or improved functionality or changes to existing functionality |
| 18 | +labels: ["enhancement"] |
| 19 | + |
| 20 | +body: |
| 21 | + - type: markdown |
| 22 | + attributes: |
| 23 | + value: | |
| 24 | + Thanks for taking the time to fill out this feature request! |
| 25 | +
|
| 26 | + - type: dropdown |
| 27 | + id: new_or_improvement |
| 28 | + attributes: |
| 29 | + label: Is this a new feature, an improvement, or a change to existing functionality? |
| 30 | + options: |
| 31 | + - New Feature |
| 32 | + - Improvement |
| 33 | + - Change |
| 34 | + validations: |
| 35 | + required: true |
| 36 | + |
| 37 | + - type: dropdown |
| 38 | + id: criticality |
| 39 | + attributes: |
| 40 | + label: How would you describe the priority of this feature request |
| 41 | + options: |
| 42 | + - Must have (e.g. nvImageCodec adoption is impossible due to lack in functionality). |
| 43 | + - Should have (e.g. Adoption is possible, but the performance shortcomings make the solution inferior). |
| 44 | + - Nice to have (e.g. Adoption is possible, the feature will enhance the use-case even more). |
| 45 | + validations: |
| 46 | + required: true |
| 47 | + |
| 48 | + - type: textarea |
| 49 | + id: problem |
| 50 | + attributes: |
| 51 | + label: Please provide a clear description of problem this feature solves |
| 52 | + description: Real usage examples are especially helpful, non-code. |
| 53 | + validations: |
| 54 | + required: true |
| 55 | + |
| 56 | + - type: textarea |
| 57 | + id: Feature_Description |
| 58 | + attributes: |
| 59 | + label: Feature Description |
| 60 | + description: Please provide clear description of the feature you request (refer to [User Story format](https://www.atlassian.com/agile/project-management/user-stories#:~:text=User%20story%20template%20and%20examples) and [EARS format](https://ieeexplore.ieee.org/document/5328509)) |
| 61 | + placeholder: > |
| 62 | + For new feature request, please use one of the following format to describe the feature |
| 63 | + 1. From End-user perspective, use the following user story format |
| 64 | + As a <persona>, I <want to>, <so that>. |
| 65 | + 2. From System perspective, use the following EARS format |
| 66 | + <Pre-Condition> <System> shall <process> <object to be process> <condition> |
| 67 | + For changing or improving existing feature, it's recommended to provide the previous Feature Request ID. |
| 68 | + validations: |
| 69 | + required: true |
| 70 | + |
| 71 | + - type: textarea |
| 72 | + id: solution |
| 73 | + attributes: |
| 74 | + label: Describe your ideal solution |
| 75 | + description: Please describe the functionality you would like added. |
| 76 | + placeholder: > |
| 77 | + A new function that takes in the information in this form, and triages the issue |
| 78 | +
|
| 79 | + def feature_request(form_info): |
| 80 | + parse(form_info) |
| 81 | + return triage_outcome |
| 82 | + You can even provide a reference implementation in other library. |
| 83 | + validations: |
| 84 | + required: true |
| 85 | + |
| 86 | + - type: textarea |
| 87 | + id: alternatives |
| 88 | + attributes: |
| 89 | + label: Describe any alternatives you have considered |
| 90 | + description: List any other libraries, or approaches you have looked at or tried. |
| 91 | + placeholder: I have looked at library xyz and qrs, but they do not offer GPU acceleration |
| 92 | + |
| 93 | + - type: textarea |
| 94 | + id: misc |
| 95 | + attributes: |
| 96 | + label: Additional context |
| 97 | + description: Add any other context, code examples, or references to existing implementations about the feature request here. If applicable, please list the modules affected. |
| 98 | + |
| 99 | + - type: checkboxes |
| 100 | + id: terms |
| 101 | + attributes: |
| 102 | + label: Check for duplicates |
| 103 | + options: |
| 104 | + - label: I have searched the [open bugs/issues](https://github.com/NVIDIA/nvImageCodec/issues) and have found no duplicates for this bug report |
| 105 | + required: true |
0 commit comments