xref: /dokuwiki/.github/ISSUE_TEMPLATE/bug_report.yml (revision e05e1bd971cf3ec250dab70e10024735eca33031)
138dc4143SAndreas Gohrname: �� Report a bug
238dc4143SAndreas Gohrdescription: Use this to report a bug in DokuWiki
33f815ae3SAndreas Gohrlabels: [ "Bug" ]
438dc4143SAndreas Gohrbody:
538dc4143SAndreas Gohr  - type: markdown
638dc4143SAndreas Gohr    attributes:
738dc4143SAndreas Gohr      value: >
838dc4143SAndreas Gohr        ### ✋ **This is bug tracker, not a support forum**
938dc4143SAndreas Gohr
1038dc4143SAndreas Gohr        If you have questions or need help, [**get in touch at the forum**](https://forum.dokuwiki.org/).
1138dc4143SAndreas Gohr
1238dc4143SAndreas Gohr
1338dc4143SAndreas Gohr        ---
1438dc4143SAndreas Gohr
1538dc4143SAndreas Gohr        **Thank you for wanting to report a bug in DokuWiki!**
1638dc4143SAndreas Gohr
1738dc4143SAndreas Gohr
1838dc4143SAndreas Gohr        If this is the first time you are doing this, please take a few moments to read
1938dc4143SAndreas Gohr        through our wiki page on [Reporting DokuWiki Bugs](https://www.dokuwiki.org/bugs).
2038dc4143SAndreas Gohr
2138dc4143SAndreas Gohr
2238dc4143SAndreas Gohr        You are about to report a bug in **DokuWiki**. Bugs in plugins should be reported
2338dc4143SAndreas Gohr        at their respective places, usually the plugin's repository.
2438dc4143SAndreas Gohr  - type: textarea
2538dc4143SAndreas Gohr    attributes:
2638dc4143SAndreas Gohr      label: The problem
2738dc4143SAndreas Gohr      description: >-
2838dc4143SAndreas Gohr        Describe the issue you are experiencing here. Basically tell us
2938dc4143SAndreas Gohr
3038dc4143SAndreas Gohr          * What you were trying to do
3138dc4143SAndreas Gohr          * What you expected to happen
3238dc4143SAndreas Gohr          * What actually happened
3338dc4143SAndreas Gohr
3438dc4143SAndreas Gohr        Provide a clear and concise description of what the problem is and include as many
3538dc4143SAndreas Gohr        details as possible. Add screenshots if you think it would help to explain the problem.
3638dc4143SAndreas Gohr
3738dc4143SAndreas Gohr
3838dc4143SAndreas Gohr        If you already tried to debug the problem, please also describe what you found out.
3938dc4143SAndreas Gohr    validations:
4038dc4143SAndreas Gohr      required: true
4138dc4143SAndreas Gohr  - type: markdown
4238dc4143SAndreas Gohr    attributes:
4338dc4143SAndreas Gohr      value: |
4438dc4143SAndreas Gohr        ## Environment
4538dc4143SAndreas Gohr  - type: input
4638dc4143SAndreas Gohr    attributes:
4738dc4143SAndreas Gohr      label: Version of DokuWiki
4838dc4143SAndreas Gohr      description: Can be found in the admin screen or in the `VERSION` file.
4938dc4143SAndreas Gohr      placeholder: 2024-02-14a "Kaos"
5038dc4143SAndreas Gohr    validations:
5138dc4143SAndreas Gohr      required: true
5238dc4143SAndreas Gohr  - type: input
5338dc4143SAndreas Gohr    attributes:
5438dc4143SAndreas Gohr      label: PHP Version
5538dc4143SAndreas Gohr      description: The version of PHP you are using to run DokuWiki
5638dc4143SAndreas Gohr      placeholder: "8.3"
5738dc4143SAndreas Gohr    validations:
5838dc4143SAndreas Gohr      required: true
5938dc4143SAndreas Gohr  - type: input
6038dc4143SAndreas Gohr    attributes:
6138dc4143SAndreas Gohr      label: Webserver and version of webserver
6238dc4143SAndreas Gohr      description: If applicable, always include if unsure
6338dc4143SAndreas Gohr      placeholder: Apache 2.4 on Debian Linux
6438dc4143SAndreas Gohr  - type: input
6538dc4143SAndreas Gohr    attributes:
6638dc4143SAndreas Gohr      label: Browser and version of browser, operating system running browser
6738dc4143SAndreas Gohr      description: If applicable, always include if unsure
6838dc4143SAndreas Gohr      placeholder: "Chrome 221 on Windows 11"
6938dc4143SAndreas Gohr  - type: textarea
7038dc4143SAndreas Gohr    attributes:
7138dc4143SAndreas Gohr      label: Additional environment information
7238dc4143SAndreas Gohr      description: >-
7338dc4143SAndreas Gohr        If you think it might be relevant, please provide any additional information about your environment here.
7438dc4143SAndreas Gohr        For example:
7538dc4143SAndreas Gohr
76*e05e1bd9SGerrit Uitslag          * Provider-, server- and network-setup like proxies, firewalls, Single-Sign-On environments etc.
7738dc4143SAndreas Gohr          * Any installed plugins or templates that might be relevant to the problem
783f815ae3SAndreas Gohr          * Your configuration settings related to the problem
7938dc4143SAndreas Gohr          * Any custom changes you made to the DokuWiki core or plugins
8038dc4143SAndreas Gohr  - type: markdown
8138dc4143SAndreas Gohr    attributes:
8238dc4143SAndreas Gohr      value: |
8338dc4143SAndreas Gohr        ## Logs and other files needed for analysis
8438dc4143SAndreas Gohr  - type: markdown
8538dc4143SAndreas Gohr    attributes:
8638dc4143SAndreas Gohr      value: >-
8738dc4143SAndreas Gohr        Please be sure to include any technical information that might be helpful in diagnosing the problem. This includes:
8838dc4143SAndreas Gohr
8938dc4143SAndreas Gohr          * Your browser's JavaScript console, if you are reporting a problem with the
9038dc4143SAndreas Gohr            user interface.
9138dc4143SAndreas Gohr          * Related entries in DokuWiki's log files. Especially when the error message states that more info has been
9238dc4143SAndreas Gohr            written to the log file.
9338dc4143SAndreas Gohr          * Related entries in your webserver's error log files.
9438dc4143SAndreas Gohr          * If possible, screenshots or videos showing the problem, especially if you
9538dc4143SAndreas Gohr            are reporting a problem with the user interface!
9638dc4143SAndreas Gohr
9738dc4143SAndreas Gohr        Again, refer to [Reporting DokuWiki Bugs](https://www.dokuwiki.org/bugs) on how to obtain these infos.
9838dc4143SAndreas Gohr  - type: textarea
9938dc4143SAndreas Gohr    attributes:
10038dc4143SAndreas Gohr      label: Relevant logs and/or error messages
10138dc4143SAndreas Gohr      description: >-
10238dc4143SAndreas Gohr        Please copy and paste any relevant logs and/or error messages here. This will automatically formatted into code, so no need for backticks.
10338dc4143SAndreas Gohr      render: text
10438dc4143SAndreas Gohr
105