Skip to content

Commit 88a8477

Browse files
committed
Enhance the Bug Tracking Documentation
This patch provides further details on how to properly file a bug.
1 parent 222ee85 commit 88a8477

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

Sources/WebKit/WebKit.docc/GettingStarted/BugTracking.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,37 @@
22

33
## Overview
44

5-
[bugs.webkit.org](https://bugs.webkit.org/) hosted is the primary bug tracking tool we use.
6-
We use bugzilla to file bugs, and then perform code review using GitHub.
5+
WebKit uses [Bugzilla](https://www.bugzilla.org) as our primary bug tracking tool, which is hosted at [bugs.webkit.org](https://bugs.webkit.org/).
6+
We use Bugzilla to file bugs, and then we perform code review using [GitHub](https://github.com/webkit/webkit).
77

8-
### Filing and Editing Bugs
8+
### Filing a Bug
99

10-
To [file a new WebKit bug](https://bugs.webkit.org/enter_bug.cgi), see [reporting bugs](https://webkit.org/reporting-bugs/).
11-
To edit an existing bug, you may need [editbug-bits](https://webkit.org/bugzilla-bits/).
10+
To [file a new WebKit bug](https://bugs.webkit.org/enter_bug.cgi) please review the steps below.
11+
12+
#### Create a Bugzilla Account
13+
You’ll need to [create a Bugzilla account](https://bugs.webkit.org/createaccount.cgi) to be able to report bugs and comment on them.
14+
15+
#### Check Your WebKit Version
16+
Please ensure you are using latest version of WebKit before filing to verify your issue has not already been resolved. You can download the latest WebKit build from our build archives [here](https://webkit.org/build-archives).
17+
18+
#### Search Bugzilla
19+
Please [search through Bugzilla](https://bugs.webkit.org/query.cgi?format=specific&product=WebKit) first to check if your issue has already been filed. This step is very important! If you find that someone has filed your bug already, please add your comments on the existing bug report.
20+
21+
#### File the Bug!
22+
If a bug does not already exist you can file a bug [here](https://webkit.org/new-bug). The [Writing a Good Bug Report](https://webkit.org/bug-report-guidelines) document gives some tips about the most useful information to include in bug reports. The better your bug report, the higher the chance that your bug will be addressed (and possibly fixed) quickly!
23+
24+
#### Next Steps
25+
Once your bug is filed, you’ll receive email when it’s updated at each stage in the [bug life cycle](https://webkit.org/bug-life-cycle). After the bug is considered fixed, you may be asked to download [the latest WebKit Build Archive](https://webkit.org/build-archives) and confirm that the fix works for you.
26+
27+
> Note: Safari specific bugs should be reported to Apple [here](https://feedbackassistant.apple.com).
28+
29+
### Editing Bugs
30+
31+
To edit an existing bug on Bugzilla you may need [editbug-bits](https://webkit.org/bugzilla-bits/).
1232

1333
### Reporting Security Bugs
1434

1535
Security bugs have their own components in [bugs.webkit.org](https://bugs.webkit.org/).
1636
We’re also working on a new policy to delay publishing tests for security fixes until after the fixes have been widely deployed.
1737

18-
_***Do not post a patch or describe a security bug in a bug that is not in security component of bugs.webkit.org.***_
38+
_***Please keep all discussions of security bugs and patches in the Security component of Bugzilla.***_

0 commit comments

Comments
 (0)