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