Browse Source

github: Initial templates

elms 2 years ago
parent
commit
0f50ffb2ef

+ 58 - 0
.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,58 @@
+name: Bug Report
+description: File a bug report
+title: "[Bug]: "
+labels: ["bug", "triage"]
+body:
+  - type: markdown
+    attributes:
+      value: >
+        Thanks for reporting an bug. If you would prefer a private method,
+        please email support@wolfssl.com
+  - type: input
+    id: contact
+    attributes:
+      label: Contact Details
+      description: How can we get in touch with you if we need more info?
+      placeholder: ex. email@example.com
+    validations:
+      required: false
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: What version were you using?
+    validations:
+      required: true
+  - type: textarea
+    id: details
+    attributes:
+      label: Description
+      description: |
+        Describe the issue in detail
+        Please include:
+          * Specific `./configure` options or `user_settings.h`
+          * Target and build environment
+      placeholder: |
+        Blinded by the light!
+        Code runs too fast. It's gone plaid!
+        ...
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Reproduction steps
+      description: If possible please give instructions on how to reproduce.
+      placeholder: |
+        1. `./configure --enable-42`
+        2. `make question`
+        3.
+        ...
+    validations:
+      required: false
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell

+ 28 - 0
.github/ISSUE_TEMPLATE/other.yaml

@@ -0,0 +1,28 @@
+name: General Issue
+description: Request support with an issue
+labels: ["triage"]
+body:
+  - type: markdown
+    attributes:
+      value: >
+        Thanks for reporting an issue. If you would prefer a private method,
+        please email support@wolfssl.com
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: What version were you using?
+    validations:
+      required: true
+  - type: textarea
+    id: details
+    attributes:
+      label: Description
+      description: |
+        Describe the issue in detail.
+        Please include specific configuration options or user_settings.h
+      placeholder: |
+        `./configure --enable-world-domination` fails
+        ...
+    validations:
+      required: true

+ 16 - 0
.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+# Description
+
+Please describe the scope of the fix or feature addition.
+
+Fixes zd#
+
+# Testing
+
+How did you test?
+
+# Checklist
+
+ - [ ] added tests
+ - [ ] updated/added doxygen
+ - [ ] updated appropriate READMEs
+ - [ ] Updated manual and documentation

+ 12 - 0
.github/SECURITY.md

@@ -0,0 +1,12 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If you discover a vulnerability, please report it to support@wolfssl.com
+
+ 1. Include a detailed description
+ 2. Include method to reproduce and/or method of discovery
+ 3. We will evaulate the report promptly and respond to you with findings.
+ 4. We will credit you with the report if you would like.
+
+**Please keep the vulnerability private** until a fix has been released.