Selaa lähdekoodia

Replace markdown issue templates with issue forms

Florian Friedrich 8 kuukautta sitten
vanhempi
sitoutus
1d7fedd11b

+ 0 - 43
.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,43 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve CocoaLumberjack
-title: ''
-labels: Bug
-assignees: ''
-
----
-
-**Checklist**
-- [ ] I have read and understood the [CONTRIBUTING guide](https://github.com/CocoaLumberjack/CocoaLumberjack/blob/master/.github/CONTRIBUTING.md)
-- [ ] I have read the [Documentation](https://github.com/CocoaLumberjack/CocoaLumberjack#documentation)
-- [ ] I have searched for a similar issue in the [project](https://github.com/CocoaLumberjack/CocoaLumberjack/issues) and found none
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Create logger '...'
-2. Log message '...'
-3. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Environment info**
-  Info                    | Value                               |
--------------------------|-------------------------------------|
- Platform Name           | e.g. ios / macos / tvos / watchos
- Platform Version        | e.g. 13.0
- CocoaLumberjack Version | e.g. 3.7.4
- Integration Method      | e.g. spm / carthage / cocoapods / manually
- Xcode Version           | e.g. Xcode 13.4
- Repro rate              | e.g. all the time (100%) / sometimes x% / only once
- Repro project link      | e.g. link to a reproduction project that highlights the issue
-
-**Additional context**
-Add any other context about the problem here.
-Are you reporting a queue deadlock? If so, please include a complete backtrace of all threads, which you can generate by typing `bt all` in the debugger after you hit the deadlock. We might not be able to fix deadlock reports without a backtrace!

+ 139 - 0
.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,139 @@
+name: Bug Report
+description: Create a report to help us improve CocoaLumberjack.
+type: Bug
+body:
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Checklist
+      options:
+        - label: I have read and understood the [CONTRIBUTING guide](https://github.com/CocoaLumberjack/CocoaLumberjack/blob/master/.github/CONTRIBUTING.md)
+          required: true
+        - label: I have read the [Documentation](https://github.com/CocoaLumberjack/CocoaLumberjack#documentation)
+          required: true
+        - label: I have searched for a similar issue in the [project](https://github.com/CocoaLumberjack/CocoaLumberjack/issues) and found none
+          required: true
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A clear and concise description of what the bug is.
+      placeholder: Logging this message crashes leads to an unexpected error.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Reproduction Steps
+      description: Steps to reproduce the behavior.
+      placeholder: |
+        1. Create logger '...'
+        2. Log message '...'
+        3. See error
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected Behavior
+      description: A clear and concise description of what you expected to happen.
+      placeholder: The message should be logged without resulting in an error.
+    validations:
+      required: false
+
+  - type: markdown
+    attributes:
+      value: "## Environment Information"
+
+  - type: dropdown
+    id: platform
+    attributes:
+      label: Platform
+      description: Select all platforms on which the issue occurs.
+      multiple: true
+      options:
+        - macOS
+        - iOS
+        - iPadOS
+        - tvOS
+        - watchOS
+        - visionOS
+    validations:
+      required: true
+
+  - type: input
+    id: platform-version
+    attributes:
+      label: Platform Version
+      description: The version(s) of the platform on which the issue occurs.
+      placeholder: "26.0"
+    validations:
+      required: true
+
+  - type: dropdown
+    id: integration
+    attributes:
+      label: Integration Method
+      description: Select the integration method used.
+      multiple: false
+      options:
+        - Swift Package Manager (SPM)
+        - CocoaPods
+        - Carthage
+        - Manual
+    validations:
+      required: true
+
+  - type: input
+    id: package-version
+    attributes:
+      label: CocoaLumberjack Version
+      description: The version(s) of CocoaLumberjack used in the project.
+      placeholder: "3.9.0"
+    validations:
+      required: true
+
+  - type: input
+    id: xcode-version
+    attributes:
+      label: Xcode Version
+      description: The version of Xcode that is used.
+    validations:
+      required: true
+
+  - type: input
+    id: repro-rate
+    attributes:
+      label: Repro Rate
+      description: The rate at which the issue can be reproduced.
+      placeholder: all the time (100%) / sometimes x% / only once
+    validations:
+      required: true
+
+  - type: input
+    id: repro-project
+    attributes:
+      label: Repro Project
+      description: A link to a sample project that reproduces the issue.
+    validations:
+      required: false
+
+  - type: markdown
+    attributes:
+      value: |
+        ## Additional Context
+
+        Are you reporting a queue deadlock?
+        If so, please include a complete backtrace of all threads, which you can generate by typing `bt all` in the debugger after you hit the deadlock. We might not be able to fix deadlock reports without a backtrace!
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: Add any other context about the problem here.
+      placeholder: Upload screenshots showing the issue, provide logs, etc.
+    validations:
+      required: false

+ 0 - 20
.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: Feature Request
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

+ 44 - 0
.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,44 @@
+name: Feature Request
+description: Suggest a new feature for CocoaLumberjack.
+type: Feature
+body:
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Checklist
+      options:
+        - label: I have read and understood the [CONTRIBUTING guide](https://github.com/CocoaLumberjack/CocoaLumberjack/blob/master/.github/CONTRIBUTING.md)
+          required: true
+        - label: I have read the [Documentation](https://github.com/CocoaLumberjack/CocoaLumberjack#documentation)
+          required: true
+        - label: I have searched for a similar issue in the [project](https://github.com/CocoaLumberjack/CocoaLumberjack/issues) and found none
+          required: true
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A clear and concise description of what you want to happen.
+      placeholder: It should be possible to write log messages to a serial output.
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives
+      description: Describe any alternative solutions or workarounds you've considered.
+      placeholder: |
+        - Tried using a different logger
+        - Wrote my own logger
+    validations:
+      required: false
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: Add any other context about the feature request here.
+      placeholder: E.g. upload a sample code snippet or project.
+    validations:
+      required: false