xref: /dokuwiki/.github/ISSUE_TEMPLATE/bug_report.yml (revision f51673e59055f994e6cc4a258e64f01e7dbdbfa2)
1name: �� Report a bug
2description: Use this to report a bug in DokuWiki
3labels: [ "Bug" ]
4body:
5  - type: markdown
6    attributes:
7      value: >
8        ### ✋ **This is bug tracker, not a support forum**
9
10        If you have questions or need help, [**get in touch at the forum**](https://forum.dokuwiki.org/).
11
12
13        ---
14
15        **Thank you for wanting to report a bug in DokuWiki!**
16
17
18        If this is the first time you are doing this, please take a few moments to read
19        through our wiki page on [Reporting DokuWiki Bugs](https://www.dokuwiki.org/bugs).
20
21
22        You are about to report a bug in **DokuWiki**. Bugs in plugins should be reported
23        at their respective places, usually the plugin's repository.
24  - type: textarea
25    attributes:
26      label: The problem
27      description: >-
28        Describe the issue you are experiencing here. Basically tell us
29
30          * What you were trying to do
31          * What you expected to happen
32          * What actually happened
33
34        Provide a clear and concise description of what the problem is and include as many
35        details as possible. Add screenshots if you think it would help to explain the problem.
36
37
38        If you already tried to debug the problem, please also describe what you found out.
39    validations:
40      required: true
41  - type: markdown
42    attributes:
43      value: |
44        ## Environment
45  - type: input
46    attributes:
47      label: Version of DokuWiki
48      description: Can be found in the admin screen or in the `VERSION` file.
49      placeholder: 2024-02-14a "Kaos"
50    validations:
51      required: true
52  - type: input
53    attributes:
54      label: PHP Version
55      description: The version of PHP you are using to run DokuWiki
56      placeholder: "8.3"
57    validations:
58      required: true
59  - type: input
60    attributes:
61      label: Webserver and version of webserver
62      description: If applicable, always include if unsure
63      placeholder: Apache 2.4 on Debian Linux
64  - type: input
65    attributes:
66      label: Browser and version of browser, operating system running browser
67      description: If applicable, always include if unsure
68      placeholder: "Chrome 221 on Windows 11"
69  - type: textarea
70    attributes:
71      label: Additional environment information
72      description: >-
73        If you think it might be relevant, please provide any additional information about your environment here.
74        For example:
75
76          * Provider-, server- and network-setup like proxies, firewalls, Single-Sign-On environments etc.
77          * Any installed plugins or templates that might be relevant to the problem
78          * Your configuration settings related to the problem
79          * Any custom changes you made to the DokuWiki core or plugins
80  - type: markdown
81    attributes:
82      value: |
83        ## Logs and other files needed for analysis
84  - type: markdown
85    attributes:
86      value: >-
87        Please be sure to include any technical information that might be helpful in diagnosing the problem. This includes:
88
89          * Your browser's JavaScript console, if you are reporting a problem with the
90            user interface.
91          * Related entries in DokuWiki's log files. Especially when the error message states that more info has been
92            written to the log file.
93          * Related entries in your webserver's error log files.
94          * If possible, screenshots or videos showing the problem, especially if you
95            are reporting a problem with the user interface!
96
97        Again, refer to [Reporting DokuWiki Bugs](https://www.dokuwiki.org/bugs) on how to obtain these infos.
98  - type: textarea
99    attributes:
100      label: Relevant logs and/or error messages
101      description: >-
102        Please copy and paste any relevant logs and/or error messages here. This will automatically formatted into code, so no need for backticks.
103      render: text
104
105