Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Finding Things to Do

Servo’s issue tracker contains a lot of issues, and it can feel overwhelming looking for something to work on. Here are some helpful tips for issue labels to look for:

Less complex issues

The E-less-complex label means that someone thinks the issue is appropriate for a new contributor. Issues with this label should contain a clear description of the problem, clear steps to follow to address it, and any expected verification steps.

More complex issues

The E-more-complex label means that someone thinks ths issue is appropriate for someone with a bit of experience. Like E-less-complex, issues with this label should contain a clear description of the problem, clear steps to follow to address it, and any expected verification steps. The difference between the two labels is the expected effort required to solve it, and they may require additional investigation to solve.

Fixing panics with minimized testcases

There are many ways to make Servo panic, and often these are found by fuzzing Servo. There are lots of examples of issues with minimized testcases (i.e. the smallest HTML/JS/CSS required to reproduce a problem) that are labelled with I-panic and C-has-manual-testcase.

These can be good issues to work on because the panic backtrace can provide pointers to relevant code, and you can focus on understanding the conditions that trigger the panic.

Minimizing testcases

It’s easy to file an issue about Servo rendering a web page incorrectly, but it’s often difficult to act on those issues. It’s very helpful to look for issues with the C-needs-minimized-testcase label and work on isolating the HTML/CSS/JS required to reproduce the problem. See the guide for tips about minimizing nontrivial pages.

Diagnosing failing Web Platform Tests

The Web Platform Tests (WPT) are Servo’s main source of automated conformance tests. There are many tests that Servo does not yet pass, and these can be found by looking at the test metadata directory. Every .ini. file under that directory corresponds to a test source file, and it can be helpful to choose a file in directory that interests you and diagnose what is causing the test not to pass.

You can also explore all the tests that Servo fails in the web-based wpt.fyi interface. See the guide for tips about identifying the cause of WPT test failures.

Triaging untriaged issues

All new issues start with a C-untriaged label. To triage an issue, we need to categorize it by area and impact, as well as the current condition of the issue, and any platform restrictions. These are all indicated through labels applied to the issue. Once an issue is triaged, we should remove the C-untriaged label.

While triage can be performed directly by any contributor or maintainer, anybody can leave a comment suggesting adding labels or next steps.

Area

To triage the area of an issue, figure out which labels with the A- prefix are relevant. Does it affect a particular web API or project component?

Impact

To triage the impact of an issue, figure out which labels with the I- prefix are relevant. Does the engine crash (I-crash) or panic (I-panic)? Does the issue trigger unnecessary memory usage (I-perf-bloat) or performance slowdowns (I-perf-slow)?

Condition

To triage the condition of an issue, figure out which labels with the C- prefix are relevant.

Is more information required from the submitter (C-clarifying)? Has someone else reproduced the problem (C-reproduced)? Is the issue a regression, and is there a regression range (C-needs-regression-range)? Are there reliable steps for anyone to reproduce the issue (C-needs-investigation), or do we still need a minimized testcase (C-needs-minimized-testcase/C-has-manual-testcase)?

Platform

To triage the platform of an issue, determine if it affects all platforms equally or only a subset of supported platforms. If only a subset are affected, find appropriate labels with the P- prefix that should be applied.