Added issue templates (#132)

Signed-off-by: Toddy Mladenov <[email protected]> Co-authored-by: Yogesh Deshpande <[email protected]>
veraison · Mar 10, 2023 · 134c56b · 134c56b
1 parent bfa9f54
commit 134c56b
Show file tree

Hide file tree

Showing 3 changed files with 170 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-or-issue.yaml b/.github/ISSUE_TEMPLATE/bug-or-issue.yaml
@@ -0,0 +1,77 @@
+# Copyright The Veraison Go-COSE Authors.
+# Licensed under the Mozilla Public License 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
+#
+# https://www.mozilla.org/en-US/MPL/2.0/
+
+# Permissions of this weak copyleft license are conditioned on making available 
+# source code of licensed files and modifications of those files under the same license 
+# (or in certain cases, one of the GNU licenses). Copyright and license notices must be preserved. 
+# Contributors provide an express grant of patent rights. However, a larger work using 
+# the licensed work may be distributed under different terms and without source code for 
+# files added in the larger work.
+#
+# 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.
+#
+# Original template copied from Notary Project https://github.com/notaryproject
+
+name: 🐛 Bug or Issue
+description: Something is not working as expected or not working at all! Report it here!
+labels: [bug, triage]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to fill out this issue report. 🛑 Please check existing issues first before continuing: https://github.com/veraison/go-cose/issues
+  - type: dropdown
+    id: area
+    validations:
+      required: true
+    attributes:
+      label: "What is the areas you experience the issue in?"
+      options: 
+        - Go-COSE Library
+  - type: textarea
+    id: verbatim
+    validations:
+      required: true
+    attributes:
+      label: "What is not working as expected?"
+      description: "In your own words, describe what the issue is."
+  - type: textarea
+    id: expect
+    validations:
+      required: true
+    attributes:
+      label: "What did you expect to happen?"
+      description: "A clear and concise description of what you expected to happen."
+  - type: textarea
+    id: reproduce
+    validations:
+      required: true
+    attributes:
+      label: "How can we reproduce it?"
+      description: "Detailed steps to reproduce the behavior. Commands and their outputs are always helpful. If the bug is in a library, code snippets work as well."
+  - type: textarea
+    id: environment
+    validations:
+      required: true
+    attributes:
+      label: Describe your environment 
+      description: "Installation method (e.g. wget, curl, brew, apt-get, yum, chocolate, MSI) if applicable / OS version / Shell type (e.g. zsh, bash, cmd.exe, Bash on Windows) / Golang version if applicable"
+  - type: textarea
+    id: version
+    validations:
+      required: true
+    attributes:
+      label: What is the version of your Go-COSE Library?
+      description: "For the libraries check the `go.mod` file."
+  - type: markdown
+    attributes:
+      value: |
+        If you want to contribute to this project, we will be happy to guide you through out contribution process especially when you already have a good proposal or understanding of how to fix this issue. Join us at https://veraison.zulipchat.com/.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,23 @@
+# Copyright The Veraison Go-COSE Authors.
+# Licensed under the Mozilla Public License 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
+#
+# https://www.mozilla.org/en-US/MPL/2.0/
+
+# Permissions of this weak copyleft license are conditioned on making available 
+# source code of licensed files and modifications of those files under the same license 
+# (or in certain cases, one of the GNU licenses). Copyright and license notices must be preserved. 
+# Contributors provide an express grant of patent rights. However, a larger work using 
+# the licensed work may be distributed under different terms and without source code for 
+# files added in the larger work.
+#
+# 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.
+#
+# Original template copied from Notary Project https://github.com/notaryproject
+
+blank_issues_enabled: true
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml
@@ -0,0 +1,70 @@
+# Copyright The Veraison Go-COSE Authors.
+# Licensed under the Mozilla Public License 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
+#
+# https://www.mozilla.org/en-US/MPL/2.0/
+
+# Permissions of this weak copyleft license are conditioned on making available 
+# source code of licensed files and modifications of those files under the same license 
+# (or in certain cases, one of the GNU licenses). Copyright and license notices must be preserved. 
+# Contributors provide an express grant of patent rights. However, a larger work using 
+# the licensed work may be distributed under different terms and without source code for 
+# files added in the larger work.
+#
+# 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.
+#
+# Original template copied from Notary Project https://github.com/notaryproject
+
+name: 🚀 Feature Request
+description: Suggest an idea for this project.
+labels: [enhancement, triage]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to suggest a useful feature for the project!
+  - type: dropdown
+    id: area
+    validations:
+      required: true
+    attributes:
+      label: "What is the areas you would like to add the new feature to?"
+      options: 
+        - Go-COSE Library
+  - type: textarea
+    id: problem
+    validations:
+      required: true
+    attributes:
+      label: "Is your feature request related to a problem?"
+      description: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]"
+  - type: textarea
+    id: solution
+    validations:
+      required: true
+    attributes:
+      label: "What solution do you propose?"
+      description: "A clear and concise description of what you want to happen."
+  - type: textarea
+    id: alternatives
+    validations:
+      required: true
+    attributes:
+      label: "What alternatives have you considered?"
+      description: "A clear and concise description of any alternative solutions or features you've considered."
+  - type: textarea
+    id: context
+    validations:
+      required: false
+    attributes:
+      label: "Any additional context?"
+      description: "Add any other context or screenshots about the feature request here."
+  - type: markdown
+    attributes:
+      value: |
+        If you want to contribute to this project, we will be happy to guide you through out contribution process especially when you already have a good proposal or understanding of how to improve the functionality. Join us at https://veraison.zulipchat.com/.