mirror of
https://github.com/LadybirdBrowser/ladybird.git
synced 2024-11-21 23:20:20 +00:00
GitHub: For issue reports, move to using structured template
This change helps to ensure issue authors include the details needed to reproduce problems — including repro steps, expected behavior, a reduced test case, and logs/backtrace.
This commit is contained in:
parent
4ecf56cadf
commit
8d52c72b3a
Notes:
github-actions[bot]
2024-10-31 08:19:04 +00:00
Author: https://github.com/sideshowbarker Commit: https://github.com/LadybirdBrowser/ladybird/commit/8d52c72b3a6 Pull-request: https://github.com/LadybirdBrowser/ladybird/pull/898
2 changed files with 130 additions and 0 deletions
116
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
116
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
|
@ -0,0 +1,116 @@
|
||||||
|
name: Report a bug
|
||||||
|
description: Create a report to help us reproduce and fix a bug.
|
||||||
|
body:
|
||||||
|
- type: textarea
|
||||||
|
id: summary
|
||||||
|
attributes:
|
||||||
|
label: Summary
|
||||||
|
description: Describe the problem in 1 or 2 short sentences.
|
||||||
|
placeholder: When I … in Ladybird, …
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: dropdown
|
||||||
|
id: os
|
||||||
|
attributes:
|
||||||
|
label: Operating system
|
||||||
|
options:
|
||||||
|
- Linux
|
||||||
|
- macOS
|
||||||
|
- Windows
|
||||||
|
- Android
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: reproduction-steps
|
||||||
|
attributes:
|
||||||
|
label: Steps to reproduce
|
||||||
|
description: Describe the exact steps we can follow to reproduce the problem.
|
||||||
|
value: |
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
3.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: expected-behavior
|
||||||
|
attributes:
|
||||||
|
label: Expected behavior
|
||||||
|
description: Describe what you expected to happen when you followed [the steps you described above](#description-reproduction-steps).
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: actual-behavior
|
||||||
|
attributes:
|
||||||
|
label: Actual behavior
|
||||||
|
description: Describe what actually happened when you followed [the steps you described above](#description-reproduction-steps).
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: markdown
|
||||||
|
id: reduced-test-case
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
<!-- add some vertical whitespace -->
|
||||||
|
## Reduced test case
|
||||||
|
Either provide the URL for a [reduced test case](https://github.com/LadybirdBrowser/ladybird/blob/master/ISSUES.md#how-you-can-write-a-reduced-test-case) that reproduces the problem, or else HTML/SVG/etc. source for a reduced test case.
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> A [reduced test case](https://github.com/LadybirdBrowser/ladybird/blob/master/ISSUES.md#how-you-can-write-a-reduced-test-case) may be the most important thing you can give us; without it, we’re much less likely to isolate the cause.
|
||||||
|
- type: input
|
||||||
|
id: reduced-test-case-url
|
||||||
|
attributes:
|
||||||
|
label: URL for a reduced test case
|
||||||
|
description: |
|
||||||
|
Provide the URL for a [reduced test case](https://github.com/LadybirdBrowser/ladybird/blob/master/ISSUES.md#how-you-can-write-a-reduced-test-case) that reproduces the problem (e.g., using a site such as [CodePen](https://codepen.io/pen/), [JS Bin](https://jsbin.com), or [JSFiddle](https://jsfiddle.net)). Or if you don’t have a [reduced test case](https://github.com/LadybirdBrowser/ladybird/blob/master/ISSUES.md#how-you-can-write-a-reduced-test-case), at least provide the URL for a website/page that causes the problem. Otherwise just enter `N/A` here.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: reduced-test-case-source
|
||||||
|
attributes:
|
||||||
|
label: HTML/SVG/etc. source for a reduced test case
|
||||||
|
description: If you’ve not provided the URL for a [reduced test case](https://github.com/LadybirdBrowser/ladybird/blob/master/ISSUES.md#how-you-can-write-a-reduced-test-case) that reproduces the problem, then paste in below the HTML/SVG/etc. source for a reduced test case. Otherwise just enter `N/A` here. What you paste in will be formatted as a code block — so, no need to put code fence backticks around it.
|
||||||
|
value:
|
||||||
|
render: html
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
<!-- add some vertical whitespace -->
|
||||||
|
- type: textarea
|
||||||
|
id: log-output
|
||||||
|
attributes:
|
||||||
|
label: |
|
||||||
|
Log output and (if possible) backtrace
|
||||||
|
description: |
|
||||||
|
Copy and paste the full log output from Ladybird — including error messages — as well as any backtrace that Ladybird reported.
|
||||||
|
What you paste in will be formatted as a code block — so, no need to put code fence backticks around it.
|
||||||
|
value:
|
||||||
|
render: shell
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: screenshots
|
||||||
|
attributes:
|
||||||
|
label: Screenshots or screen recordings
|
||||||
|
description: Drag and drop in below any screenshots or screen recordings you’ve made which show the problem.
|
||||||
|
- type: textarea
|
||||||
|
id: build-flags
|
||||||
|
attributes:
|
||||||
|
label: Build flags or config settings
|
||||||
|
description: If you’re building with any non-default build flags or other non-default config settings in your environment, list them out below.
|
||||||
|
- type: checkboxes
|
||||||
|
id: will-patch
|
||||||
|
attributes:
|
||||||
|
label: Contribute a patch?
|
||||||
|
description: |
|
||||||
|
If you plan to contribute patch for this issue yourself, please check the box below — to tell us and others looking at the issue that someone’s already working on it. If you do check this box, please try to send a pull request within 7 days or so.
|
||||||
|
options:
|
||||||
|
- label: I’ll contribute a patch for this myself.
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
<!-- add some vertical whitespace -->
|
||||||
|
## :heart: Become a Ladybird supporter
|
||||||
|
|
||||||
|
Ladybird is funded entirely by sponsorships and donations from people and companies who care about the open web.\
|
||||||
|
We accept one-time and recurring monthly donations via [**Donorbox**](https://donorbox.org/ladybird).
|
||||||
|
<!-- add some vertical whitespace -->
|
14
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
14
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
@ -0,0 +1,14 @@
|
||||||
|
blank_issues_enabled: true
|
||||||
|
contact_links:
|
||||||
|
- name: Join our Discord server
|
||||||
|
url: https://discord.gg/nvfjVJ4Svh
|
||||||
|
about: Chat with the Ladybird maintainers and contributors and other users.
|
||||||
|
- name: Read our FAQ
|
||||||
|
url: https://github.com/LadybirdBrowser/ladybird/blob/master/Documentation/FAQ.md
|
||||||
|
about: Read answers for some of the most frequently-asked questions about Ladybird.
|
||||||
|
- name: Read our documentation
|
||||||
|
url: https://github.com/LadybirdBrowser/ladybird/blob/master/Documentation/README.md
|
||||||
|
about: Read the docs about building Ladybird, and about configuring your Ladybird development environment.
|
||||||
|
- name: Contribute to Ladybird
|
||||||
|
url: https://github.com/LadybirdBrowser/ladybird/blob/master/CONTRIBUTING.md
|
||||||
|
about: Read about how you can get started contributing to Ladybird.
|
Loading…
Reference in a new issue