Add Issue Templates (#832)

* Add Some Issue Templates

* Improve

* Improve Templates

* Add Code Blocks

* Reword

* Reword LKM Bug Description

* Add dmesg Output
This commit is contained in:
TheBrokenRail 2020-06-16 18:46:31 -04:00 committed by GitHub
parent 77da61ee85
commit 69a3b39766
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 165 additions and 0 deletions

21
.github/ISSUE_TEMPLATE/build_issue.md vendored Normal file
View File

@ -0,0 +1,21 @@
---
name: Build Issue
about: An issue building Darling
labels: 'build'
---
**Build Log**
What is the build error?
```
Put the build log here!
```
**System Information**
What system are you building with?
| Software | Version |
| --- | --- |
| Clang | X.Y.Z |
| CMake | X.Y.Z |
| Linux Kernel | X.Y.Z |
| Darling | Git Commit Hash |

28
.github/ISSUE_TEMPLATE/lkm_bug.md vendored Normal file
View File

@ -0,0 +1,28 @@
---
name: LKM Bug
about: An issue with the Linux kernel module
labels: 'bug, linux kernel module'
---
**Expected Result**
What did you expect to happen?
**Actual Result**
What did happen?
**Steps To Reproduce**
1. If possible, what steps can you take to reproduce the issue?
**``dmesg`` Output**
Run ```dmesg | grep 'overlay\|darling'```
```
Put the command output here!
```
**System Information**
What system are you using?
| Software | Version |
| --- | --- |
| Linux Kernel | X.Y.Z |
| Darling | Git Commit Hash |

22
.github/ISSUE_TEMPLATE/misc_bug.md vendored Normal file
View File

@ -0,0 +1,22 @@
---
name: Miscellaneous Bug
about: A miscellaneous bug in Darling
labels: 'bug'
---
**Expected Result**
What did you expect to happen?
**Actual Result**
What did happen?
**Steps To Reproduce**
1. If possible, what steps can you take to reproduce the issue?
**System Information**
What system are you using?
| Software | Version |
| --- | --- |
| Linux Kernel | X.Y.Z |
| Darling | Git Commit Hash |

View File

@ -0,0 +1,21 @@
---
name: Missing Framework
about: An application requires a missing framework
labels: 'frameworks, application compatibility'
---
**Framework**
What framework is required? What does Apple's developer documentation say about it? Is it open-source?
**Test Application**
What application requires this framework?
**Steps To Reproduce**
1. If possible, what steps can you take to reproduce the issue?
**System Information**
What system are you running?
| Software | Version |
| --- | --- |
| Darling | Git Commit Hash |

View File

@ -0,0 +1,21 @@
---
name: Missing Library
about: An application requires a missing library
labels: 'libraries, application compatibility'
---
**Library**
What library is required? What does Apple's developer documentation say about it? Is it open-source?
**Test Application**
What application requires this library?
**Steps To Reproduce**
1. If possible, what steps can you take to reproduce the issue?
**System Information**
What system are you running?
| Software | Version |
| --- | --- |
| Darling | Git Commit Hash |

18
.github/ISSUE_TEMPLATE/missing_tool.md vendored Normal file
View File

@ -0,0 +1,18 @@
---
name: Missing Built-In Tool
about: MacOS contains a command-line tool that Darling does not
labels: 'enhancement'
---
**Tool**
What tool is missing? What is it supposed to do? Is it or a variant open-source?
**Example Command**
What is an example command for this tool?
**System Information**
What system are you running?
| Software | Version |
| --- | --- |
| Darling | Git Commit Hash |

34
.github/ISSUE_TEMPLATE/startup_bug.md vendored Normal file
View File

@ -0,0 +1,34 @@
---
name: Startup Bug
about: An issue with Darling's startup
labels: 'bug, container'
---
**Expected Result**
What did you expect to happen?
**Actual Result**
What did happen?
**Steps To Reproduce**
1. If possible, what steps can you take to reproduce the issue?
**```strace``` Output**
Run ```sudo strace -f -u $USER darling shell```, what is the output?
```
Put the command output here!
```
**``dmesg`` Output**
Run ```dmesg | grep 'overlay\|darling'```
```
Put the command output here!
```
**System Information**
What system are you running?
| Software | Version |
| --- | --- |
| Linux Kernel | X.Y.Z |
| Darling | Git Commit Hash |