bug_report.yml 3.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. name: Bug report
  2. description: "Report sing-box bug"
  3. body:
  4. - type: dropdown
  5. attributes:
  6. label: Operating system
  7. description: Operating system type
  8. options:
  9. - iOS
  10. - macOS
  11. - Apple tvOS
  12. - Android
  13. - Windows
  14. - Linux
  15. - Others
  16. validations:
  17. required: true
  18. - type: input
  19. attributes:
  20. label: System version
  21. description: Please provide the operating system version
  22. validations:
  23. required: true
  24. - type: dropdown
  25. attributes:
  26. label: Installation type
  27. description: Please provide the sing-box installation type
  28. options:
  29. - Original sing-box Command Line
  30. - sing-box for iOS Graphical Client
  31. - sing-box for macOS Graphical Client
  32. - sing-box for Apple tvOS Graphical Client
  33. - sing-box for Android Graphical Client
  34. - Third-party graphical clients that advertise themselves as using sing-box (Windows)
  35. - Third-party graphical clients that advertise themselves as using sing-box (Android)
  36. - Others
  37. validations:
  38. required: true
  39. - type: input
  40. attributes:
  41. description: Graphical client version
  42. label: If you are using a graphical client, please provide the version of the client.
  43. - type: textarea
  44. attributes:
  45. label: Version
  46. description: If you are using the original command line program, please provide the output of the `sing-box version` command.
  47. render: shell
  48. - type: textarea
  49. attributes:
  50. label: Description
  51. description: Please provide a detailed description of the error.
  52. validations:
  53. required: true
  54. - type: textarea
  55. attributes:
  56. label: Reproduction
  57. description: Please provide the steps to reproduce the error, including the configuration files and procedures that can locally (not dependent on the remote server) reproduce the error using the original command line program of sing-box.
  58. validations:
  59. required: true
  60. - type: textarea
  61. attributes:
  62. label: Logs
  63. description: |-
  64. In addition, if you encounter a crash with the graphical client, please also provide crash logs.
  65. For Apple platform clients, please check `Settings - View Service Log` for crash logs.
  66. For the Android client, please check the `/sdcard/Android/data/io.nekohasekai.sfa/files/stderr.log` file for crash logs.
  67. render: shell
  68. - type: checkboxes
  69. id: supporter
  70. attributes:
  71. label: Supporter
  72. options:
  73. - label: I am a [sponsor](https://github.com/sponsors/nekohasekai/)
  74. - type: checkboxes
  75. attributes:
  76. label: Integrity requirements
  77. description: |-
  78. Please check all of the following options to prove that you have read and understood the requirements, otherwise this issue will be closed.
  79. Sing-box is not a project aimed to please users who can't make any meaningful contributions and gain unethical influence. If you deceive here to deliberately waste the time of the developers, you will be permanently blocked.
  80. options:
  81. - label: I confirm that I have read the documentation, understand the meaning of all the configuration items I wrote, and did not pile up seemingly useful options or default values.
  82. required: true
  83. - label: I confirm that I have provided the server and client configuration files and process that can be reproduced locally, instead of a complicated client configuration file that has been stripped of sensitive data.
  84. required: true
  85. - label: I confirm that I have provided the simplest configuration that can be used to reproduce the error I reported, instead of depending on remote servers, TUN, graphical interface clients, or other closed-source software.
  86. required: true
  87. - label: I confirm that I have provided the complete configuration files and logs, rather than just providing parts I think are useful out of confidence in my own intelligence.
  88. required: true