From 51912bf0da3141519e2df5c25b29ac4ef6bc4b0e Mon Sep 17 00:00:00 2001 From: sideshowbarker Date: Tue, 30 Jul 2024 14:59:30 +0900 Subject: [PATCH] Documentation: Make updates to align better with new issue template --- CONTRIBUTING.md | 2 ++ Documentation/Troubleshooting.md | 2 +- ISSUES.md | 33 +++---------------- SECURITY.md | 4 +-- .../LibWebView/ViewImplementation.cpp | 2 +- 5 files changed, 10 insertions(+), 33 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 42bfe88fb32..f5e27808656 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,6 +4,8 @@ When contributing to Ladybird, make sure that the changes you wish to make are i **For your first couple of PRs, start with something small to get familiar with the project and its development processes. Please do not start by adding a large component.** +Read [the Ladybird documentation](https://github.com/LadybirdBrowser/ladybird/blob/master/CONTRIBUTING.md), including the documents in the **Development** section of the `Documentation/README.md` file. + Everyone is welcome to work on the project, and while we have lots of fun, it's a serious kind of fun. :^) ## Communication diff --git a/Documentation/Troubleshooting.md b/Documentation/Troubleshooting.md index ee3bc5df1f0..1d2eb6286aa 100644 --- a/Documentation/Troubleshooting.md +++ b/Documentation/Troubleshooting.md @@ -32,7 +32,7 @@ CipherString = DEFAULT@SECLEVEL=1 Options = UnsafeLegacyRenegotiation ``` -#### “Targets may link only to libraries. CMake is dropping the item” message (when building with the Qt chrome on macOS) +### “Targets may link only to libraries. CMake is dropping the item” message (when building with the Qt chrome on macOS) When building with the Qt chrome on macOS, you may encounter the following message: diff --git a/ISSUES.md b/ISSUES.md index b2a0805966b..2c85d32ab9a 100644 --- a/ISSUES.md +++ b/ISSUES.md @@ -1,32 +1,7 @@ -# Detailed issue-reporting guidelines +# Issue-reporting guidelines -When reporting an issue, you should should try to provide: - -1. Succinct prose description of the problem (in addition to the issue title). - -2. Exact steps for reproducing the problem. - -3. Description of what you expect to see happen (the expected behavior) when you follow those steps. - -4. Description of what actually happens instead (the actual behavior) when you follow those steps. - -5. Either: - - * The URL for a [reduced test case](#how-you-can-write-a-reduced-test-case) that reproduces the problem (e.g., using a site such as https://codepen.io/pen/, https://jsbin.com, or https://jsfiddle.net), or else at least the URL for a website/page that causes the problem. - - * The HTML source for a reduced test case that reproduces the problem. - -6. Backtrace and Ladybird log output. - -7. Screenshot or screen recording. - -8. Operating system (Linux/macOS/Window/Android) in which you’re building or running Ladybird. - -9. Browser chrome of the build (Qt/AppKit/AndroidUI). - -10. Config/build flags you’re building with. - -11. Whether you’re interested yourself in trying to write a patch/PR with the fix for the problem. +Report problems using our detailed [bug-reporting +form](https://github.com/LadybirdBrowser/ladybird/issues/new?template=bug_report.yml), which helps to ensure that, for us to reproduce and investigate the problem, your bug report includes the information needed — including a reduced test case. ## How you can write a reduced test case @@ -46,7 +21,7 @@ Here’s how you can do that: ``` - However, if the problem appears be caused not by anything in the source of the document itself, but instead by something in an external script or external stylesheet, then you’ll also need to create a local copy of the problem script or problem stylesheet. + However, if the problem appears to be caused not by anything in the source of the document itself, but instead by something in an external script or external stylesheet, then you’ll also need to create a local copy of the problem script or problem stylesheet. 3. Open/load the `REDUCTION.html` file in Ladybird, and verify that the same problem occurs with it as occurs with the original website/page you copied it from. diff --git a/SECURITY.md b/SECURITY.md index 224d9e10194..46d8ad28e28 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,7 +1,7 @@ # Security Policy Ladybird is unreleased software still in early development, and so bugs and vulnerabilities in its code can be safely -disclosed publicly. The preference is to report security issues as [GitHub issues](https://github.com/LadybirdBrowser/ladybird/issues/new). +disclosed publicly. The preference is to report security issues as [GitHub issues](https://github.com/LadybirdBrowser/ladybird/issues/new?template=bug_report.yml). However, private vulnerability reporting is also enabled on the repository. If you find a security issue in Ladybird, or in another web browser that you believe affects Ladybird, you may report it privately to the maintainers @@ -12,7 +12,7 @@ and given a security advisory identifier. The maintainers may include regular co process as their expertise requires. Researchers who report security issues privately will be credited in the advisory. The maintainers reserve the right to reject reports that are not security issues, or that are not in the scope of Ladybird. -For issues that are determined to not be security issues, please report them as a [GitHub issue](https://github.com/LadybirdBrowser/ladybird/issues/new) +For issues that are determined to not be security issues, please report them as a [GitHub issue](https://github.com/LadybirdBrowser/ladybird/issues/new?template=bug_report.yml) instead. If you choose not to re-report the issue as a generic issue, the maintainers may do so themselves. Ladybird does not offer bug bounties for security issues at this time. diff --git a/Userland/Libraries/LibWebView/ViewImplementation.cpp b/Userland/Libraries/LibWebView/ViewImplementation.cpp index adc2616bd98..22ec92214fc 100644 --- a/Userland/Libraries/LibWebView/ViewImplementation.cpp +++ b/Userland/Libraries/LibWebView/ViewImplementation.cpp @@ -497,7 +497,7 @@ void ViewImplementation::handle_resize() void ViewImplementation::handle_web_content_process_crash() { dbgln("WebContent process crashed!"); - dbgln("Consider raising an issue at https://github.com/LadybirdBrowser/ladybird/issues"); + dbgln("Consider raising an issue at https://github.com/LadybirdBrowser/ladybird/issues/new/choose"); ++m_crash_count; constexpr size_t max_reasonable_crash_count = 5U;